This repository was archived by the owner on Apr 11, 2025. It is now read-only.
[IMP][UPD] Documentation Big Bang #88
Merged
Conversation
This file contains hidden or 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
Fixup intro.rst Fixup intro.rst naming Fixup pip install in advanced.rst
Fixup logo [IMP] Update requirements update requirements file use book theme Fixup cleanup conf.py cleanup unused files
fixup glyphs in installdeps.rst fixup glyphs in install.rst fixup glyphs in quickstart.rst fixup glyphs in advanced.rst fixup glyphs in installdeps.rst Fixup quickstart upd glyphs and leftover renaming
Update to reflect new repo/project name Change draft pull request policy It no longer makes sense to change the title of a pr. Since we now have tags and draft statusses which can be used. [IMP] Contributing guide
The book-theme offers better readability on tables.
fixup pypilink in index
Fixup advanced.rst center the images [IMP] add full-width class
bosd added documentation This was referenced Aug 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
1 participant
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.
Excuse me for this (opinionated) Big Bang Documentation update, as part of rebranding.
I've worked extensively on this.
Want this of my chest..
Since the readthedocs is live will merge this quickly.
After that, democratic process can return and smaller incremental updates.
Superseeding #28
Part of #9
Rename package, but keep cli / api calls unchanged
Install book theme (Better display for table hovering)
General documentation improvements
Use pygment lexers to easy copy-paste commands
Use python 3.10 to build the docs
Use sphinx click to auto document the command line interface
Refactor Changelog
Benchmark page (Will likely land in separate PR)