Skip to content

Commit 2614bb0

Browse files
committed
update docs-contribution.rst page after docs directory restructuring
1 parent 878558c commit 2614bb0

3 files changed

Lines changed: 16 additions & 2 deletions

File tree

docs/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,15 @@
5050
"sphinx_copybutton",
5151
"sphinx_tabs.tabs",
5252
"sphinx_iconify",
53+
# "sphinx_docsearch",
5354
# CUSTOM EXTENSIONS
5455
"pennair_contributors",
5556
]
57+
#
58+
# docsearch_app_id = "<DOCSEARCH_APP_ID>"
59+
# docsearch_api_key = "<DOCSEARCH_SEARCH_API_KEY>"
60+
# docsearch_index_name = "<DOCSEARCH_INDEX_NAME>"
61+
#
5662
if not SKIP_AUTOAPI_BUILD:
5763
extensions.append("autoapi.extension")
5864
add_module_names = False # object names don't show full header path so its not too verbose. E.g., uav.modes.LandingMode vs LandingMode

docs/docs-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ sphinx-new-tab-link
99
sphinx-copybutton
1010
sphinx-tabs
1111
sphinx-iconify
12+
sphinx-docsearch

docs/pages/docs-contribution.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ First, create a virtual environment and install all required dependencies.
2626

2727
.. code-block:: bash
2828
29-
cd sphinx
29+
cd docs
3030
python3 -m venv venv
3131
source venv/bin/activate
3232
pip install -r docs-requirements.txt
@@ -36,7 +36,7 @@ First, create a virtual environment and install all required dependencies.
3636

3737
.. code-block:: bash
3838
39-
cd sphinx
39+
cd docs
4040
uv venv venv
4141
source venv/bin/activate
4242
uv pip install -r docs-requirements.txt
@@ -49,6 +49,13 @@ Then, run the command for serving locally:
4949
5050
make serve
5151
52+
Alternatively, if you want to skip the autoapi build step:
53+
54+
.. code-block:: bash
55+
:caption: Bash
56+
57+
SKIP_AUTOAPI_BUILD=1 make serve
58+
5259
.. note::
5360

5461
We use ``sphinx-autoapi`` to generate the Python API Reference. ``sphinx-autobuild`` is used to

0 commit comments

Comments
 (0)