Generate html documentation and man pages using Sphinx #470
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
|
Issue #142 discusses moving the website and Sphinx conversion. |
cjmayo
force-pushed
the
sphinx
branch
2 times, most recently
from
ab2af61
to
2747dbc
Compare
This was referenced Aug 8, 2020
Create code documentation: make -C doc code Create html: make -C doc html
First man pages generated with Sphinx.
This is the automatic conversion only. Much manual work still required.
Convert to reST to integrate without adding another dependency.
|
No longer draft, prerequisites now merged. Included existing documentation, did convert CONTRIBUTING.md and CODE_OF_CONDUCT.md to reST. |
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.
Talked about briefly before:
I also wanted to write some notes about how LinkChecker works, to make it easier to work on. To support those notes I have included Sphinx autodoc pages for the linkcheck package. Overkill? It does actually seem quite useful, you can get to the code itself.
To help the review I've published the html output at: https://cjmayo.github.io/linkchecker-html/.
Draft, not least because it depends on the other recent PRs.