This repository has been archived by the owner on Oct 8, 2023. It is now read-only.
From markdown to restructuredtext #199
Open
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
added 3 commits
August 30, 2018 15:40
Parser cleanup its bad style to set __all__ with values that doesnt exist. Its confusing. Signed-off-by: Sebastian Tobie <sebastian@sebastian-tobie.de>
cython now embeds docstrings into the binary. If we document the cython pyx and pxd, the hints files are obsolete and stop breaking sphinx. And we dont need two implementations of the same class. Signed-off-by: Sebastian Tobie <sebastian@sebastian-tobie.de>
the big I reformated the markdown files to restrucured Text and putted them into docs/docs. The docs/api directory has the required files for the automatic documentation of the modules. sphinx-autodoc-typehints adds the typehints to the docs. Signed-off-by: Sebastian Tobie <sebastian@sebastian-tobie.de>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fork the repository and create your branch from master.
based on master
Run the build.py and test.py scripts.
Same output like master
If you are fixing something, add tests that fail in the current version and pass in yours.
If you're developing a new feature open an issue first to discuss it. Some features may be useful to you but harmful to others be it because of performance, new dependencies or different perspectives.
Issue #138
Ensure the entire test suite is passing and overall performance is not degraded.
good docs make the development faster
The last commit will contain the theme and similar options.