JHUAPL/kaipy
1
0
Fork 0
mirror of https://github.com/JHUAPL/kaipy.git synced 2026-01-09 07:48:04 -05:00
Code Issues Packages Projects Releases 2 Wiki Activity

Update to RTD instructions

Browse Source
This commit is contained in:
wiltbemj
2024-08-26 07:24:47 -06:00
parent 2377974e5c
commit 95fdf452b1
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/rtd-buildnotes.txt
View File

@@ -3,12 +3,13 @@ This file contains notes for the build process of kaipy on ReadTheDocs
First you need to have sphinx and the RTD Theme installed
pip install sphinx
pip install sphinx-rtd-Theme
pip install sphinx-rtd-theme
pip install sphinxcontrib-autoprogram
sphinx-quickstart has already been run from the docs directory to create
the starting point for the documentation.
We have made source part of the repo, but not made buil part of the repo.
We have made source part of the repo, but not made build part of the repo.
This choice was made because RTD reconstructs the build directory during install process
All docstrings must follow Google Style so that the napolean option will work with autodoc