Improve web docs #2248
Merged
Improve web docs #2248
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
when building web docs
when building web docs
afh
force-pushed
the
improve-web-docs
branch
7 times, most recently
from
7ae9c84
to
5718998
Compare
using pydoc when building web docs.
afh
commented
Apr 25, 2023
|
|
||
| #if !DEBUG_MODE | ||
| docstring_options doc_options; | ||
| doc_options.disable_cpp_signatures(); |
There was a problem hiding this comment.
For details about docstring_options see https://www.boost.org/doc/libs/1_82_0/libs/python/doc/html/reference/high_level_components/boost_python_docstring_options_h.html
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.
Improve HTML rendition of Ledger's man page
Unfortunately groff's HTML output of the Ledger man page isn't too readable due to breaks on lines that belong on the same line and with much space between tabbed content. Use of mandoc(1) remedies that
groffmandocGenerate documentation for Ledger Python module using pydoc
A live preview is available at http://projects.surryhill.net/ledger/ledger.html
Future the documentation of the Ledger Python module and package is probably better generated using sphinx and the autodocs extension. For now the result of pydoc is better than offering no documentation at all.
ℹ️ For details on the other changes please see the individual commits