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

Fix sphinx-build warnings #1518

Merged
merged 52 commits into from
Nov 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
585a221
Fix - WARNING: Title underline too short
steffengraber Mar 26, 2020
de354c2
Fix - WARNING: Title underline too short
steffengraber Mar 26, 2020
f3a804e
Fix - WARNING: Unknown target name: "synapse models"
steffengraber Mar 26, 2020
1df32ab
Fix - WARNING: toctree contains reference to nonexisting document 'to…
steffengraber Mar 26, 2020
9f4eb1f
Fix - WARNING: toctree contains reference to nonexisting document
steffengraber Mar 26, 2020
4b1bcf3
Changed links to ipynb downloads
steffengraber Mar 27, 2020
a85f6d6
Fix - WARNING: Duplicate explicit target name
steffengraber Mar 27, 2020
556701d
Fix - WARNING: toctree contains reference to nonexisting document
steffengraber Mar 27, 2020
acbdd85
Fix WARNING: Unknown directive type 'subnet_rm' in 'guides/from_nest2…
sarakonradi Apr 2, 2020
6de9d21
Fix WARNING: Unknown directive type 'model_rm' in 'guides/from_nest2_…
sarakonradi Apr 2, 2020
6d392d4
Fix WARNING: Unknown directive type 'function_rm' in 'guides/from_nes…
sarakonradi Apr 2, 2020
ef7cd1d
Fix Title underline too short in 'models/conductance.rst'
sarakonradi Apr 2, 2020
cd63d2d
Fix Title underline too short in 'models/current-based.rst'
sarakonradi Apr 2, 2020
8567bd3
Fix Title underline too short in 'ref_material/nest2_vs_3.rst'
sarakonradi Apr 2, 2020
d24381f
Fix WARNING: image file not readable in 'installation/index.rst'
sarakonradi Apr 2, 2020
08bc037
Fix WARNING: document isn't included in any toctree in 'citing-nest.rst'
sarakonradi Apr 17, 2020
8d713ad
Fix WARNING: document isn't included in any toctree in 'connection-ge…
sarakonradi Apr 17, 2020
95a63c5
Fix WARNING: document isn't included in any toctree in 'contribute/ma…
sarakonradi Apr 17, 2020
bf44d31
Fix WARNING: toctree isn't included in any documents in 'example_temp…
sarakonradi Apr 17, 2020
6b604b5
Fix WARNING: document isn't included in any toctree in 'pyapi_templat…
sarakonradi Apr 17, 2020
1ff5368
Fix WARNING: document isn't included in any toctree in 'vim_support_s…
sarakonradi Apr 17, 2020
3912021
Fix WARNING: document isn't included in any toctree in 'faqs/index.rst'
sarakonradi Apr 17, 2020
d04856b
Fix WARNING: document isn't included in any toctree in 'features.rst'
sarakonradi Apr 17, 2020
b29f94c
Fix WARNING: document isn't included in any toctree in 'glossary.rst'
sarakonradi Apr 17, 2020
6e91eb9
Fix WARNING: document isn't included in any toctree in 'pynest.rst'
sarakonradi Apr 17, 2020
4e49946
Fix WARNING: document isn't included in any toctree in 'oldvers_insta…
sarakonradi Apr 17, 2020
fa4fc2e
Fix WARNING: document isn't included in any toctree in 'microcircuit/…
sarakonradi Apr 17, 2020
7e05e71
Fix WARNING: document isn't included in any toctree in 'README.rst'
sarakonradi Apr 17, 2020
fa9a40f
Fix WARNING: document isn't included in any toctree in 'an-introducti…
sarakonradi Apr 17, 2020
3d483f1
Fix WARNING: document isn't included in any toctree in 'first-steps.rst'
sarakonradi Apr 17, 2020
1dff637
Fix WARNING: document isn't included in any toctree in 'neural-simula…
sarakonradi Apr 17, 2020
01d22bb
Fix WARNING: document isn't included in any toctree in 'sli_docs.rst'
sarakonradi Apr 17, 2020
4981602
Fix WARNING: document isn't included in any toctree in 'programming-i…
sarakonradi Apr 17, 2020
9f39262
Fix WARNING: document isn't included in any toctree in 'using-files-a…
sarakonradi Apr 17, 2020
9bbff86
Fix WARNING: document isn't included in any toctree in 'music_tutoria…
sarakonradi Apr 17, 2020
d6cec31
Fix WARNING: document isn't included in any toctree in 'music_tutoria…
sarakonradi Apr 17, 2020
26f02b6
Fix WARNING: document isn't included in any toctree in 'music_tutoria…
sarakonradi Apr 17, 2020
beab26b
Merge branch 'master' into cleanup-doc
steffengraber Apr 20, 2020
6fee7b8
Fix WARNING: unknown document in connection_management.rst
sarakonradi Apr 20, 2020
112df3b
Fix WARNING: unknown document in nest2_to_nest3_overview_guide.rst
sarakonradi Apr 20, 2020
bc65c72
Fix WARNING: unknown document in running_simulations.rst
sarakonradi Apr 20, 2020
4d988f2
Fix WARNING: unknown document in oldvers_install.rst
sarakonradi Apr 20, 2020
ebd23b9
Fix WARNING: unknown document in oldvers_install.rst
sarakonradi Apr 20, 2020
c567cdb
Fix WARNING: unknown document in part_2_populations_of_neurons.rst
sarakonradi Apr 20, 2020
6b3143a
Fix WARNING: unknown document in part_3_connecting_networks_with_syna…
sarakonradi Apr 20, 2020
88355bd
Fix WARNING: unknown document in part_4_spatially_structured_networks…
sarakonradi Apr 20, 2020
58c2450
Added title
steffengraber Apr 23, 2020
8df2e3a
Merge branch 'master' into cleanup-doc
steffengraber May 14, 2020
b66df91
Apply suggestions from code review
sarakonradi Nov 10, 2020
c777c33
Merge master
sarakonradi Nov 10, 2020
64de9d3
Move :orphan: to beginning of file
sarakonradi Nov 10, 2020
444fd2f
Update title underlines
sarakonradi Nov 10, 2020
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
4 changes: 3 additions & 1 deletion doc/README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:orphan:

The doc folder
===============
==============

The documentation for NEST is contained in this folder. We are currently working
on improving the documentation and making updates. However, if you notice
Expand Down
2 changes: 2 additions & 0 deletions doc/citing-nest.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Cite NEST
=========

Expand Down
5 changes: 3 additions & 2 deletions doc/contribute/mailing_list_guidelines.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:orphan:

Guidelines for contributing to the mailing list
=================================================
===============================================

To ensure community members provide accurate and quick responses to questions on the mailing list,
please follow the guidelines below:
Expand Down Expand Up @@ -40,4 +42,3 @@ knowledge and experience to those seeking advice.
`Access the mailing list here <https://www.nest-initiative.org/mailinglist/>`_
------------------------------------------------------------------------------------


4 changes: 3 additions & 1 deletion doc/contribute/templates_styleguides/example_template.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
:orphan:

PyNEST example template
==========================
=======================


.. literalinclude:: pynest_example_template.py
4 changes: 3 additions & 1 deletion doc/contribute/templates_styleguides/pyapi_template.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
:orphan:

PyNEST API template
=====================
===================

.. literalinclude:: pynest_api_template.py
4 changes: 3 additions & 1 deletion doc/contribute/templates_styleguides/vim_support_sli.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Vim support for SLI files
=========================

Expand All @@ -14,4 +16,4 @@ Then add the following lines to your ``~/.vimrc`` file to use it:
" sli
au BufRead,BufNewFile *.sli set filetype=sli
au FileType sli setl foldenable foldmethod=syntax
au FileType sli setl foldenable foldmethod=syntax
1 change: 0 additions & 1 deletion doc/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ PyNEST examples
:maxdepth: 1
:caption: Random balanced network examples

../auto_examples/brunel_alpha_numpy
../auto_examples/brunel_alpha_nest
../auto_examples/brunel_delta_nest
../auto_examples/brunel_siegert_nest
Expand Down
2 changes: 2 additions & 0 deletions doc/faqs/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Frequently Asked Questions
==========================

Expand Down
2 changes: 1 addition & 1 deletion doc/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,4 @@ Supported platforms
By support we mean that we regularly test and use NEST on recent
versions of these systems and that NEST therefore should work on those
systems. It should not be construed as any warranty that NEST will run
on any particular system.
on any particular system.
9 changes: 5 additions & 4 deletions doc/glossary.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
:orphan:

Glossary
==============
========

Common abbreviations in NEST
------------------------------
----------------------------
.. glossary::

iaf
Expand Down Expand Up @@ -57,7 +59,7 @@ Common abbreviations in NEST
virtual process

Physical units and variable names used for NEST parameters
-------------------------------------------------------------
----------------------------------------------------------

.. note::

Expand Down Expand Up @@ -141,4 +143,3 @@ Physical units and variable names used for NEST parameters
Potassium reversal potential in mV.



2 changes: 2 additions & 0 deletions doc/guides/conngen_interface.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

The Connection Generator Interface
==================================

Expand Down
2 changes: 1 addition & 1 deletion doc/guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Here you can find details on a variety of topics in NEST.
:maxdepth: 1
:caption: Model Details

exact-integration
exact-integration
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@ The logic module contains logical expressions between nest.Parameter's.
.. _distr_param:

:green:`spatial_distributions`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The spatial_distributions module contains random distributions that take a spatial
parameter as input and applies the distribution on the parameter. They are used
for spatially distributed nodes.
Expand Down
8 changes: 1 addition & 7 deletions doc/guides/nest2_to_nest3/nest2_to_nest3_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ as NodeCollections.

.. seealso::

You can find a :doc:`full example <../examples/SynapseCollection>` in our example network page
You can find a :doc:`full example <../../auto_examples/synapsecollection>` in our example network page.

Printing
Printing a SynapseCollection produces a table of source and target node IDs
Expand Down Expand Up @@ -1468,8 +1468,6 @@ All details about the new infrastructure can be found in the guide on
What's removed?
---------------

.. subnet_rm::

Subnets
~~~~~~~

Expand Down Expand Up @@ -1502,8 +1500,6 @@ prints ID ranges and model names of the nodes in the network.
| | |
+----------------------------------------------+---------------------------------------+

.. model_rm::

Models
~~~~~~

Expand All @@ -1527,8 +1523,6 @@ be used instead.
Furthermore, the model `iaf_tum_2000` has been renamed to `iaf_psc_exp_htum`. iaf_psc_exp_htum is
the exact same model as iaf_tum_2000, it has just been renamed to match NEST's naming conventions.

.. function_rm::

Functions
~~~~~~~~~

Expand Down
2 changes: 1 addition & 1 deletion doc/guides/running_simulations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ end of the interval* during which the threshold was crossed.

NEST also has a some models that determine the precise time of the
threshold crossing during the interval. Please see the documentation on
:doc:`precise spike time neurons <simulations_with_precise_spike_time>`
:doc:`precise spike time neurons <simulations_with_precise_spike_times>`
for details about neuron update in continuous time and the
:doc:`documentation on connection management <connection_management>`
for how to set the delay when creating synapses.
Expand Down
4 changes: 2 additions & 2 deletions doc/guides/spatial/guide_spatially_structured_networks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ To create a spatially distributed NodeCollection from a list, do the following:
:start-after: #{ layer4b #}
:end-before: #{ end #}

.. _fig_layer4:
.. _fig_layer4b:

.. figure:: user_manual_figures/layer4b.png
:name: fig:layer4b
Expand Down Expand Up @@ -339,7 +339,7 @@ the shape argument, ``shape=[nx, ny, nz]``:
:start-after: #{ layer4_3d_b #}
:end-before: #{ end #}

.. _fig_layer4_3d:
.. _fig_layer4_3d_b:

.. figure:: user_manual_figures/layer4_3d_b.png
:name: fig:layer4_3d_b
Expand Down
2 changes: 2 additions & 0 deletions doc/guides/spatial/pynest.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

pynest package
==============

Expand Down
3 changes: 1 addition & 2 deletions doc/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ provide containerized versions of NEST in several formats:
generated, as shown below. You can then copy and paste the
link into your browser.

.. image:: ../../_static/img/docker_link.png
.. image:: ../_static/img/docker_link.png
:align: center
:width: 1000px

Expand Down Expand Up @@ -332,7 +332,6 @@ these instructions.**

linux_install
mac_install
conda_install
hpc_install
livemedia
install_options
2 changes: 2 additions & 0 deletions doc/sli_docs/an-introduction-to-sli.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

An Introduction to SLI
======================

Expand Down
2 changes: 2 additions & 0 deletions doc/sli_docs/first-steps.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

First Steps
===========

Expand Down
2 changes: 2 additions & 0 deletions doc/sli_docs/neural-simulations.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Neural simulations
==================

Expand Down
2 changes: 2 additions & 0 deletions doc/sli_docs/objects-and-data-types.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Objects and data types
======================

Expand Down
2 changes: 2 additions & 0 deletions doc/sli_docs/programming-in-sli.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Programming in SLI
==================

Expand Down
2 changes: 2 additions & 0 deletions doc/sli_docs/using-files-and-keyboard-input.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Using files and keyboard input
==============================

Expand Down
2 changes: 2 additions & 0 deletions doc/tutorials/music_tutorial/music_tutorial_parrot.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Those parrot neurons, or why you never connect devices to each other
--------------------------------------------------------------------

Expand Down
2 changes: 2 additions & 0 deletions doc/tutorials/music_tutorial/music_tutorial_setlatency.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

The SetAcceptableLatency command
--------------------------------

Expand Down
2 changes: 2 additions & 0 deletions doc/tutorials/music_tutorial/music_tutorial_sli.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

MUSIC with SLI
==============

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,7 @@ was built correctly:

It may also be useful to look at the ``.spatial`` property of the
NodeCollection, which describes the spatial properties. Other useful
functions that may be of help are listed in :doc:`<../../ref_material/nest2_vs_3>`
Section 4.1 *Query functions*.
functions that may be of help are listed in the :doc:`../../guides/nest2_to_nest3/nest2_to_nest3_detailed_transition_guide`.

>>> ex_pop.spatial
{'center': (0.0, 0.0),
Expand Down
2 changes: 1 addition & 1 deletion pynest/examples/glif_cond_neuron.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

"""
Conductance-based generalized leaky integrate and fire (GLIF) neuron example
--------------------------------
----------------------------------------------------------------------------
Simple example of how to use the ``glif_cond`` neuron model for
five different levels of GLIF neurons.
Expand Down
2 changes: 1 addition & 1 deletion pynest/examples/glif_psc_neuron.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

"""
Current-based generalized leaky integrate and fire (GLIF) neuron example
--------------------------------
------------------------------------------------------------------------
Simple example of how to use the ``glif_psc`` neuron model for
five different levels of GLIF neurons.
Expand Down
1 change: 1 addition & 0 deletions pynest/examples/spatial/connex_ew.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

"""
NEST spatial example
--------------------
Create two populations of iaf_psc_alpha neurons on a 30x30 grid with edge_wrap,
connect with circular mask, flat probability,
Expand Down
2 changes: 1 addition & 1 deletion pynest/examples/spatial/hill_tononi_Vp.py
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ def nop(s=None, block=None):

##############################################################################
# Synapse models
# =-------------
# --------------
#
# Actual synapse dynamics, e.g., properties such as the synaptic time
# course, time constants, reversal potentials, are properties of
Expand Down