Add scaffolding to build C++/Python docs#323
Open
oleksandr-pavlyk wants to merge 3 commits intoNVIDIA:mainfrom
Open
Add scaffolding to build C++/Python docs#323oleksandr-pavlyk wants to merge 3 commits intoNVIDIA:mainfrom
oleksandr-pavlyk wants to merge 3 commits intoNVIDIA:mainfrom
Conversation
oleksandr-pavlyk
force-pushed
the
doc-generation
branch
from
e6a6db8 to
6946b27
Compare
oleksandr-pavlyk
force-pushed
the
doc-generation
branch
from
6946b27 to
3426631
Compare
Add sphinx-combined folder that builds combined C++ & Python docs Fixed relative text alignment in docstrings to fix autodoc warnigns Renamed cuda.bench.test_cpp_exception and cuda.bench.test_py_exception functions to start with underscore, signaling that these functions are internal and should not be documented Account for test_cpp_exceptions -> _test_cpp_exception, same for *_py_* Fix cpp_benchmarks, add py_benchmarks 1. Fixed xrefs in docs/sphinx-combined/cpp_benchmarks.md, which is built on top of docs/benchmarks.md Added level-1 heading, and pushed existing headings one level down. 2. Added py_benchmarks.md to document benchmarking of Python scripts. 3. Rearranged entries in index.rst so that overview documents come before API enumeration. Make sure to reset __module__ of reexported symbols to be cuda.bench Enumerate free functions in nvbench:: namespace Tweak to index.rst intro sentence and title Changed title, fixed references, added intro borrowed from README Fix punctuation in one of the itemlist item text Hide TOC from the index page. It is too long and confusing
oleksandr-pavlyk
force-pushed
the
doc-generation
branch
from
4b5375f to
eda6a28
Compare
Use miniforge to create Python environment. Install doc dependencies, install tools needed to build Python package for autodocs to work. Build documentation, and publish rendered artifact in PR
oleksandr-pavlyk
force-pushed
the
doc-generation
branch
from
eda6a28 to
2898e64
Compare
oleksandr-pavlyk
force-pushed
the
doc-generation
branch
from
bfd4392 to
3cc96a3
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #324
This PR adds
docs/sphinx-combinedfolder anddocs/build_combined_docs.shscript to orchestrate use of doxygen and sphinx.To build docs, the following steps where used to create and configure environment:
Then
Build Python package
Note: Editable build is broken at the moment.
Build documentation
View the documentation
Open browser and navigate to
http://127.0.0.1:8001/to view rendered documentation.