From b3599326398966991853a0ce1bcc99d23cfa38d7 Mon Sep 17 00:00:00 2001 From: Scott Fleming Date: Thu, 16 Jan 2025 16:51:18 -0500 Subject: [PATCH] adding better tip of how to build docs locally with sphinx directly --- DEVELOPER_DOC.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/DEVELOPER_DOC.rst b/DEVELOPER_DOC.rst index 491ebff..5cf1ad0 100644 --- a/DEVELOPER_DOC.rst +++ b/DEVELOPER_DOC.rst @@ -34,7 +34,6 @@ Tests can also be run directly with pytest: $ pip install -e .[test] $ pytest - Documentation @@ -52,11 +51,10 @@ You can also build the documentation with Sphinx directly using: .. code-block:: bash - $ pip install -e .[docs] $ cd docs - $ make html + $ sphinx-build -M html . _build/ -The built docs will be in ``docs/_build/html/``, to view them go to ``file:///path/to/astronify/repo/docs/_build/html/index.html`` in the browser of your choice. +The built docs will be in ``docs/_build/html/``, to view them go to ``file://docs/_build/html/index.html`` in the browser of your choice. Release Protocol