Generate documentation and add link to readme (#1479) #1486
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
This documentation is for all but two modules (qs and tex). pdoc fails to render these as they use the `from .module import x` format which I am unfamiliar with. The command to generated DOCUMENTATION.md was: `pdoc api arxiv github googlescholar model network query rss text utils wikipedia > ../DOCUMENTATION.md`
Unfortunately these files must be slightly modified for the generation. As such, these files should be tested in the environments they are used to ensure that these are not breaking changes.
|
closing in favour of #1557 |
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.
For #1479
This PR introduces DOCUMENTATION.md which is generated by pdoc. This lists all the docstrings in one place, allowing people to easily search for the modules and methods that may be of use to them. There are two caveats:
pdoc) only outputs in markdown, HTML and PDF. As such, DOCUMENTATION.md will be the only markdown file in this repository.pdocdoes not correctly handle thefrom .x import yimport format. As such, two modules —qsandtex— must be adjusted so that the documentation can be generated. Therefore these should be tested in the environments they are used, to ensure that these are not breaking changes.If either of these are deal breakers, I'll look into other generators.
With the addition of a config file, hyperlinking can be added to the module names (example) which is helpful for UX, but I didn't want to introduce this file to the repository.