Skip to content

Commit

Permalink
Create rtd config file, split requirements, and pin versions
Browse files Browse the repository at this point in the history
This does exactly what we did to fix the rtd builds over in [1].

[1] - simonsobs/socs#209
  • Loading branch information
BrianJKoopman committed Oct 29, 2021
1 parent e7c9351 commit 84a71c1
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 5 deletions.
10 changes: 10 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: 2

sphinx:
configuration: docs/conf.py

python:
version: 3.7
install:
- requirements: docs/requirements.txt
- requirements: requirements.txt
6 changes: 4 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,12 @@ be considered unstable.

Documentation
-------------
The OCS documentation can be built using sphinx once you have performed the
installation::
The OCS documentation can be built using Sphinx. There is a separate
``requirements.txt`` file in the ``docs/`` directory to install Sphinx and any
additional documentation dependencies::

$ cd docs/
$ pip3 install -r requirements.txt
$ make html

You can then open ``docs/_build/html/index.html`` in your preferred web
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx==4.2.0
sphinx_rtd_theme==1.0.0
sphinx-argparse==0.3.1
4 changes: 1 addition & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ numpy
pyserial

# Documentation generation
sphinx
sphinx-argparse
sphinx_rtd_theme
# see docs/requirements.txt

# checkdata
progress
Expand Down

0 comments on commit 84a71c1

Please sign in to comment.