Skip to content

Commit e403b37

Browse files
committed
update docs
1 parent cc5a971 commit e403b37

File tree

6 files changed

+12
-59
lines changed

6 files changed

+12
-59
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
'sphinx.ext.autosummary',
7070
'sphinx.ext.intersphinx',
7171
'sphinx.ext.mathjax',
72-
'sphinx-mathjax-offline',
72+
# 'sphinx-mathjax-offline',
7373
'sphinx.ext.napoleon',
7474
'sphinx.ext.viewcode',
7575
'sphinx_autodoc_typehints',

docs/index.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,14 @@ The code of BrainPy is open-sourced at GitHub:
8686
tutorial_advanced/adavanced_lowdim_analysis.ipynb
8787
tutorial_advanced/operator_customization.ipynb
8888
tutorial_advanced/interoperation.ipynb
89-
tutorial_advanced/compile_brainpylib
90-
tutorial_advanced/citing_and_publication
89+
90+
91+
92+
.. toctree::
93+
:maxdepth: 1
94+
:caption: Frequently Asked Questions
95+
96+
tutorial_FAQs/citing_and_publication
9197

9298

9399
.. toctree::

docs/quickstart/installation.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,6 @@ of BrainPy, you can use:
3535
pip install --pre brainpy
3636
3737
38-
To install ``brainpylib`` (needed in dedicated operators), you can use:
39-
40-
.. code-block:: bash
41-
42-
pip install brainpylib
43-
44-
4538
4639
Installation from source
4740
------------------------
@@ -174,7 +167,7 @@ Many customized operators in BrainPy are implemented in ``brainpylib``.
174167
175168
For GPU operators, you should compile ``brainpylib`` from source.
176169
The details please see
177-
`Compile GPU operators in brainpylib <../tutorial_advanced/compile_brainpylib.html>`_.
170+
`Compile GPU operators in brainpylib <https://brainpy.readthedocs.io/en/latest/quickstart/installation.html>`_.
178171

179172

180173
Other Dependency
@@ -214,3 +207,4 @@ packages:
214207
.. _Numba: https://numba.pydata.org/
215208
.. _CUDA: https://developer.nvidia.com/cuda-downloads
216209
.. _CuDNN: https://developer.nvidia.com/CUDNN
210+
File renamed without changes.

docs/tutorial_advanced/compile_brainpylib.rst

Lines changed: 0 additions & 47 deletions
This file was deleted.

requirements-doc.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ myst-nb
1515
sphinx_book_theme
1616
sphinx-autodoc-typehints
1717
sphinx_thebe
18-
sphinx-mathjax-offline
18+
# sphinx-mathjax-offline

0 commit comments

Comments
 (0)