Documenting how to build docs (#35)

* Alphabetized docs list, added sphinx_rtd_theme * Added Contributing section to the README
krassowski · Nov 2, 2023 · 0672544 · 0672544
1 parent 0be0f1e
commit 0672544
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -308,6 +308,16 @@ If you wish to enable (optional, `pandas`-based) parsing utilities use:
 pip install easy-entrez[with_parsing_utils]
 ```
 
+### Contributing
+
+To build the documentation locally:
+
+```bash
+pip install -e .[docs]
+sphinx-build docs docs/_build
+open docs/_build/index.html
+```
+
 ### Alternatives
 
 You might want to try:

diff --git a/setup.py b/setup.py
@@ -49,11 +49,12 @@ def get_long_description(file_name):
             'with_progress_bars': ['tqdm'],
             'with_parsing_utils': ['pandas'],
             'docs': [
-                'sphinx<6.0',
+                'myst-parser',
                 'pydata-sphinx-theme',
+                'sphinx<6.0',
                 'sphinx-autodoc-typehints',
                 'sphinx-copybutton',
-                'myst-parser'
+                'sphinx_rtd_theme',
             ]
         }
     )