Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-update docs when working on documentation #457

Merged
merged 3 commits into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

livehtml:
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ myst-parser
nbsphinx
pandoc
sphinx-autoapi
sphinx-autobuild
sphinx-copybutton
sphinx-togglebutton
sphinx_rtd_theme
Expand Down
18 changes: 18 additions & 0 deletions docs/source/Contribution-guide/Documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,24 @@ Followed by specific example:
#EXAMPLE
my_files = loader("./maps/*.png")

Previewing your changes
------------------------

To preview your changes, you can build the documentation locally.

To do this, navigate to the ``MapReader/docs`` directory and run:

.. code-block:: bash

make livehtml

This will build the documentation and open a new tab in your browser with the documentation.

.. note::
If a new tab does not open automatically, you can navigate to ``http://127.0.0.1:8000`` in your browser to view the live documentation.

The ``livehtml`` command will automatically update the documentation as you make changes to the files.

When you are finished
----------------------

Expand Down
Loading