Skip to content

Commit 0fc328f

Browse files
committed
updated readme & config to fix a couple of build errors/warnings
1 parent 40e6c0e commit 0fc328f

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We welcome contributions to the documentation. If you wish to contribute a clari
1111
After you've forked and cloned the repository, install [Sphinx](https://www.sphinx-doc.org/en/master/), a [reStructuredText](http://docutils.sourceforge.net/rst.html) documentation generator, and [sphinx-autobuild](https://pypi.org/project/sphinx-autobuild/), a utility that will host and update the documentation as you work:
1212

1313
```
14-
pip install sphinx sphinx-autobuild sphinx-fontawesome sphinxcontrib-images
14+
pip install sphinx sphinx-autobuild sphinx-fontawesome sphinxcontrib-images sphinx-rtd-theme
1515
```
1616

1717
These docs also depend on a custom fork of the `sphinxcontrib-programoutput` extension. It can be installed by running:
@@ -60,8 +60,8 @@ git push origin doc-update
6060

6161
Then visit the [civic-docs pull requests page](https://github.com/griffithlab/civic-docs/pulls). Github should display a message asking you if you'd like to create a pull request from the new branch you just pushed. Create the pull request with a short description of your contribution. A CIViC maintainer will evaluate your contribution and will likely merge it with the master branch, which will then be published. Thanks for your contributions!
6262

63-
6463
## Setting up Sphinx to work in Docker
64+
6565
If you wind up in Python dependency hell getting Sphinx to work, you may want to try working in a Docker image by doing something like the following:
6666

6767
```
@@ -74,4 +74,3 @@ sphinx-autobuild --host 0.0.0.0 --port 8000 ./ ./_build/html
7474
```
7575

7676
To view the updated docs site in your web browser go to: http://0.0.0.0:8000/. Once you are satisfied, submit a pull request as described above.
77-

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
#
6464
# This is also used if you do content translation via gettext catalogs.
6565
# Usually you set "language" from the command line for these cases.
66-
language = None
66+
language = 'en'
6767

6868
# List of patterns, relative to source directory, that match files and
6969
# directories to ignore when looking for source files.

0 commit comments

Comments
 (0)