MHPY-10 documentation #8
Conversation
lennertvandevelde
force-pushed
the
mhpy-10-documentation
branch
from
19c0071 to
54a7d72
Compare
maartends
left a comment
maartends
left a comment
There was a problem hiding this comment.
Since this is - or will be - a public library, I would definitely include the README as it was before as well: the "Usage" and "Synopsis" sections provide a useful introduction to the library.
The title of the README should best remain "MediaHaven Python Library"
Co-authored-by: Maarten <763374+maartends@users.noreply.github.com>
spacid
left a comment
spacid
left a comment
There was a problem hiding this comment.
Which version of handsdown was used to generate the docs?
It might be advised to:
- Add the
handsdownlibrary in therequirements-dev.txtfile. - Add some information about how to generate the docs in the README.
| @@ -0,0 +1,6 @@ | |||
| #!/bin/bash | |||
|
|
|||
| handsdown | |||
There was a problem hiding this comment.
| handsdown | |
| handsdown mediahaven |
Only create docs for the files in the mediahaven folder. Without it, it also tried to generate docs for certain packages in my venv folder.
| #!/bin/bash | ||
|
|
||
| handsdown | ||
| mv docs/README.md . |
There was a problem hiding this comment.
This moves a generated README.md file to the root folder, essentially overwriting the existing README file. This is not desired.
| sed -i 's/mediahaven\//docs\/mediahaven\//g' README.md | ||
| find docs/ -type f -exec sed -i 's/\.\.\/README\.md/..\/..\/README.md/g' {} \; No newline at end of file |
There was a problem hiding this comment.
Not moving the README file makes these replace actions unnecessary I assume?
|
Note: the docs needs to be remade because of merge of |
Documentation generated with https://vemel.github.io/handsdown/.