DOC: Switch documentation from epydoc to pdoc #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
epydoc was never updated for python3. pdoc seems to have a similar design philosophy, although there are some differences from epytext. I should ask about NumPy-style docstrings. It would bring formatting into alignment, but it would take more vertical space. It would also look somewhat more natural in pydoc/help. Google-style might make more sense with the existing choices, but I don't know it as well.
|
Note: should change this to add EDIT: Apparently |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
epydoc appears to be python-2-only. Since the extended support for Python 2 ended four years ago, it's probably time to update.
pdoc seems to have a similar design philosophy to epydoc, so I switched to that, rather than the more-configurable Sphinx.
GitHub Pages serves documentation from the
docsdirectory rather than thehtmldirectory, so I changed thecreate_docs.shscript to put its output there. Let me know if you want me to revert that, or to rename thehtmldirectory todocsinstead.It should be possible to install the package required to do this with
pip install /path/to/pyspharm[docs]