update doc

tardis-sn · Jun 3, 2021 · c87678b · c87678b
1 parent a04ee89
commit c87678b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/development/documentation_guidelines.rst b/docs/development/documentation_guidelines.rst
@@ -29,7 +29,10 @@ or ::
     cd docs
     make html
 
-.. note :: If you're working on a fresh local copy of the TARDIS repository, you might need to do ``python setup.py develop`` before executing these commands.
+.. note :: 
+
+    - If you're working on a fresh local copy of the TARDIS repository, you might need to do ``python setup.py develop`` before executing these commands.
+    - Prepend ``DISABLE_NBSPHINX=1`` to the build command to disable notebook rendering (fast mode).
 
 After running this command, you can find the built docs (i.e. HTML webpages) in ``docs/_build``. Open the ``index.html`` in your browser to see how the documentation looks like with your edits. Navigate to page where you made changes or file that you added to check whether it looks as intended or not.
 

diff --git a/docs/development/index.rst b/docs/development/index.rst
@@ -14,9 +14,9 @@ to the Astropy team for designing it.
     issues
     git_workflow
     documentation_guidelines
+    documentation_preview
     running_tests
     code_quality
-    documentation_preview
     developer_faq
 
 TARDIS core team Instructions