File tree Expand file tree Collapse file tree 3 files changed +32
-0
lines changed
Expand file tree Collapse file tree 3 files changed +32
-0
lines changed Original file line number Diff line number Diff line change 1+ # Build the documentation
2+
3+ 1 . Install the ` cuda-bindings ` package of the version that we need to document.
4+ 2 . Ensure the version is included in the [ ` versions.json ` ] ( ./versions.json ) .
5+ 3 . Build the docs with ` ./build_docs.sh ` .
6+ 4 . The html artifacts should be available under both ` ./build/html/latest ` and ` ./build/html/<version> ` .
7+
8+ Alternatively, we can build all the docs at once by running [ ` cuda_python/docs/build_all_docs.sh ` ] ( ../../cuda_python/docs/build_all_docs.sh ) .
9+
10+ To publish the docs with the built version, it is important to note that the html files of older versions
11+ should be kept intact, in order for the version selection (through ` versions.json ` ) to work.
Original file line number Diff line number Diff line change 1+ # Build the documentation
2+
3+ 1 . Install the ` cuda-core ` package of the version that we need to document.
4+ 2 . Ensure the version is included in the [ ` versions.json ` ] ( ./versions.json ) .
5+ 3 . Build the docs with ` ./build_docs.sh ` .
6+ 4 . The html artifacts should be available under both ` ./build/html/latest ` and ` ./build/html/<version> ` .
7+
8+ Alternatively, we can build all the docs at once by running [ ` cuda_python/docs/build_all_docs.sh ` ] ( ../../cuda_python/docs/build_all_docs.sh ) .
9+
10+ To publish the docs with the built version, it is important to note that the html files of older versions
11+ should be kept intact, in order for the version selection (through ` versions.json ` ) to work.
Original file line number Diff line number Diff line change 1+ # Build the documentation
2+
3+ 1 . Ensure the version is included in the [ ` versions.json ` ] ( ./versions.json ) .
4+ 2 . Build the docs with ` ./build_docs.sh ` .
5+ 3 . The html artifacts should be available under both ` ./build/html/latest ` and ` ./build/html/<version> ` .
6+
7+ Alternatively, we can build all the docs at once by running [ ` ./build_all_docs.sh ` ] ( ./build_all_docs.sh ) .
8+
9+ To publish the docs with the built version, it is important to note that the html files of older versions
10+ should be kept intact, in order for the version selection (through ` versions.json ` ) to work.
You can’t perform that action at this time.
0 commit comments