Opened 11 years ago
Closed 10 years ago
#214 closed defect (fixed)
documentation misrendered
Reported by: | Zooko | Owned by: | Brian Warner |
---|---|---|---|
Priority: | major | Milestone: | 0.7.0 |
Component: | documentation | Version: | 0.6.4 |
Keywords: | Cc: |
Description
Look at this screenshot. The foolscap docs are messed up. I was about to post about foolscap to the cryptography mailing list, which is why I was looking at it.
Attachments (1)
Change History (5)
Changed 11 years ago by
Attachment: | foolscapscreenshot.png added |
---|
comment:1 Changed 11 years ago by
comment:2 Changed 11 years ago by
Here is the page of misrendered docs: http://foolscap.lothar.com/docs/using-foolscap.html
comment:3 Changed 10 years ago by
Milestone: | undecided → 0.7.0 |
---|---|
Owner: | set to Brian Warner |
Status: | new → assigned |
We've (finally) reformatted the docs to .rst, with inline code examples (unfortunately not automatically interpolated). Part of the 0.7. release process should be to remove the docs hosted on foolscap.lothar.com and instead direct folks to the github-rendered .rst files at https://github.com/warner/foolscap/blob/master/doc/using-foolscap.rst
comment:4 Changed 10 years ago by
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
wiki front page is updated. We'll still need to generate API docs (with epydoc), but we can stop updating the rest of the docs.
I posted about foolscap to the crypto list: http://www.metzdowd.com/pipermail/cryptography/2013-October/018164.html
(John Kelsey is a great cryptographer and was one of the NIST personnel responsible for the SHA-3 project.)