From 06725449755712e4d1ed80102cdeb4b4f27df095 Mon Sep 17 00:00:00 2001 From: James Braza Date: Thu, 2 Nov 2023 14:59:16 -0700 Subject: [PATCH] Documenting how to build docs (#35) * Alphabetized docs list, added sphinx_rtd_theme * Added Contributing section to the README --- README.md | 10 ++++++++++ setup.py | 5 +++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b26c0b..a87b8db 100644 --- 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 index 6bf1f08..e34e3a4 100644 --- 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', ] } )