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

Restructure the userdoc directory #2283

Merged
merged 59 commits into from
May 10, 2022
Merged
Show file tree
Hide file tree
Changes from 44 commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
ff19b76
move files to topic folders
jessica-mitchell Oct 19, 2021
bc900d6
add index page
jessica-mitchell Oct 20, 2021
e869578
change global table of contents
jessica-mitchell Oct 20, 2021
5f42a3e
reorganize structure of toc
jessica-mitchell Nov 10, 2021
afc45fb
reorganize docs, add coupling and behavior directories
jessica-mitchell Nov 10, 2021
47c6205
add empty files for links; update contents to include dev space; outl…
jessica-mitchell Nov 10, 2021
9399568
rename toc to shorter titles
jessica-mitchell Nov 18, 2021
7c0f006
remove non existent doc placeholders and add todo instead
jessica-mitchell Nov 19, 2021
6ae6f72
move nest-server
jessica-mitchell Nov 19, 2021
11b9035
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Jan 17, 2022
4049e27
set max depth to 1
jessica-mitchell Jan 17, 2022
534368a
update main toc
jessica-mitchell Jan 17, 2022
3912bdb
move devdocs into user, and move all contributing and sli into it
jessica-mitchell Jan 17, 2022
47592a2
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Feb 1, 2022
bb3fff4
fix broken link
jessica-mitchell Feb 1, 2022
70a7b6e
add content to page
jessica-mitchell Feb 1, 2022
4ab6ff7
add relatedt projects to toc
jessica-mitchell Feb 1, 2022
e2059d4
fix typo and add nest 2-3 ref guide
jessica-mitchell Feb 3, 2022
d50d3f0
add reference to index pages and move glossary
jessica-mitchell Feb 7, 2022
39a9b93
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Feb 23, 2022
0440192
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Feb 28, 2022
8c7a355
rename folders, removing doc and rearrange toc files
jessica-mitchell Mar 8, 2022
5e381cd
move all sli docs into slidocs
jessica-mitchell Mar 8, 2022
be9b639
move userdoc into doc
jessica-mitchell Mar 8, 2022
36de29e
update paths to remove userdoc
jessica-mitchell Mar 8, 2022
28d6ad7
fix broken links in networks
jessica-mitchell Mar 8, 2022
a96e174
fix link for tooltip
jessica-mitchell Mar 8, 2022
47b5e49
get make html to work - cp source contents, only remove html director…
jessica-mitchell Mar 8, 2022
064dd83
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Mar 8, 2022
8d6c7f5
.readthedocs.yml
jessica-mitchell Mar 8, 2022
088e4a2
fix mssg
jessica-mitchell Mar 8, 2022
66220f5
fix pep8
jessica-mitchell Mar 9, 2022
e6d789b
Revert "move userdoc into doc"
jessica-mitchell Mar 9, 2022
aa831fe
Revert "update paths to remove userdoc"
jessica-mitchell Mar 9, 2022
6be2719
revert changes to CMakeLists
jessica-mitchell Mar 9, 2022
e3acfc4
update path yml
jessica-mitchell Mar 9, 2022
6a71d01
revert sli docs back to doc folder
jessica-mitchell Mar 9, 2022
643055a
rename userdoc to htmldoc
jessica-mitchell Mar 9, 2022
74051d4
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Mar 11, 2022
fdddae5
Update doc/htmldoc/models/models-main.rst
jessica-mitchell Mar 14, 2022
0fd9eef
apply suggestions from review
jessica-mitchell Mar 14, 2022
f509482
fix sli docs index
jessica-mitchell Mar 14, 2022
11d635a
apply suggestions from code review
jessica-mitchell Mar 15, 2022
3930cb4
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Mar 15, 2022
84dbab1
Update doc/htmldoc/community.rst
jessica-mitchell Mar 18, 2022
096c37a
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Mar 22, 2022
e273e9d
Merge branch 'new-doc-folder-structure' of github.com:jessica-mitchel…
jessica-mitchell Mar 22, 2022
e4b24ef
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Mar 28, 2022
225bd4e
apply suggestions from discussion, simplify toc
jessica-mitchell Apr 20, 2022
9443436
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Apr 20, 2022
6a3c316
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell Apr 21, 2022
26a240d
pep8
jessica-mitchell Apr 22, 2022
458f1ff
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell May 2, 2022
0e3b748
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell May 4, 2022
c754efd
apply suggestions from review
jessica-mitchell May 4, 2022
38595a2
pep8
jessica-mitchell May 4, 2022
c909ce4
pep8
jessica-mitchell May 4, 2022
56878a0
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell May 9, 2022
0032cdd
Merge branch 'master' into new-doc-folder-structure
jessica-mitchell May 10, 2022
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
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: 2

sphinx:
builder: html
configuration: doc/userdoc/conf.py
configuration: doc/htmldoc/conf.py

python:
version: 3.8
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ We review each pull request according to our [code review guidelines](https://ne

## Submitting Changes

* Sign the [Contributor License Agreement](https://raw.githubusercontent.com/nest/nest-simulator/master/doc/userdoc/contribute/NEST_Contributor_Agreement.pdf).
* Sign the [Contributor License Agreement](https://raw.githubusercontent.com/nest/nest-simulator/master/doc/htmldoc/contribute/NEST_Contributor_Agreement.pdf).
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the [NEST repository](https://github.com/nest/nest-simulator).
* If your pull request affects documented issues, [mention](https://github.com/blog/957-introducing-issue-mentions) them in the description. If it is solving an issue, you can [state this explicitly](https://help.github.com/articles/closing-issues-via-commit-messages/).
Expand Down
4 changes: 2 additions & 2 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ else ()
set( OUT_OF_TREE_BUILD "True" )
endif ()

set( DOC_BUILD_DIR "${PROJECT_BINARY_DIR}/doc/userdoc" )
set( DOC_SOURCE_DIR "${PROJECT_SOURCE_DIR}/doc/userdoc" )
set( DOC_BUILD_DIR "${PROJECT_BINARY_DIR}/doc/htmldoc" )
set( DOC_SOURCE_DIR "${PROJECT_SOURCE_DIR}/doc/htmldoc" )

add_custom_target( html
COMMAND [ "${OUT_OF_TREE_BUILD}" = "True" ] && rm -rf "${DOC_BUILD_DIR}" || true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
# for rtd builds
if os.environ.get("READTHEDOCS") == "True":
branch_name = base_url.split('/doc/')[0].split('/')[-1]
refuri = (f'/en/{branch_name}/glossary.html#term-{term}')
refuri = (f'/en/{branch_name}/ref_material/glossary.html#term-{term}')
# for local builds
else:
refuri = base_url.split('userdoc')[0] + f'userdoc/html/glossary.html#term-{term}'
Expand Down Expand Up @@ -209,7 +209,7 @@ def get_desc_from_glossary(term):
"""

try:
with open(str(doc_build_dir) + '/glossary.rst') as f:
with open(str(doc_build_dir) + '/ref_material/glossary.rst') as f:
file_content = f.read()

# generate a list of lines from file content.
Expand Down
File renamed without changes.
2 changes: 0 additions & 2 deletions doc/userdoc/citing-nest.rst → doc/htmldoc/citing-nest.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

.. _cite_nest:

Cite NEST
Expand Down
File renamed without changes.
26 changes: 8 additions & 18 deletions doc/userdoc/community.rst → doc/htmldoc/community.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _community:

NEST Community
==============
Contact us
==========

Mailing list
------------
Expand All @@ -16,6 +16,12 @@ By subscribing to the mailing list you will also get notified of all NEST relate

Before submitting a question, please take a look at our :ref:`guidelines for the NEST mailing list <mail_guidelines>`.

Submit an issue or pull request on Github
-----------------------------------------

You can :ref:`issues` on Github or contribute to the code or documentation. See our :ref:`contriute` page for
details.

Open video conference
---------------------

Expand All @@ -25,20 +31,4 @@ This is an opportunity to have discussions in real time with developers.

Information for dates and how to join can be found on `our GitHub wiki <https://github.com/nest/nest-simulator/wiki/Open-NEST-Developer-Video-Conference>`_

Publications using NEST
-----------------------

We have compiled a `list of NEST-related peer-reviewed publications <https://www.nest-simulator.org/publications/>`_ that
we update regularly.

If you have used NEST in your research, let us know!
Don't forget to :ref:`cite NEST <cite_nest>` in your work.

Have a talk or poster where you used NEST? `Download our logo <https://github.com/nest/nest-simulator/tree/master/doc/logos>`_!

Become a NEST member
--------------------

If you would like to be actively involved in the NEST Initiative and support its
goals, please see our `member page <https://www.nest-initiative.org/membership>`_.

4 changes: 2 additions & 2 deletions doc/userdoc/conf.py → doc/htmldoc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@


if os.environ.get("READTHEDOCS") == "True":
doc_build_dir = source_dir / "doc/userdoc"
doc_build_dir = source_dir / "doc/htmldoc"
else:
doc_build_dir = Path(os.environ["OLDPWD"]) / "doc/userdoc"
doc_build_dir = Path(os.environ["OLDPWD"]) / "doc/htmldoc"

sys.path.append(os.path.abspath("./_ext"))

Expand Down
11 changes: 11 additions & 0 deletions doc/htmldoc/connect_nest/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _connect_index:

Connect NEST with other tools
=============================


.. toctree::
:maxdepth: 1

nest_server
using_nest_with_music
File renamed without changes.
56 changes: 56 additions & 0 deletions doc/htmldoc/contents.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
Table of Contents
=================


.. toctree::
:maxdepth: 1
:caption: Get started

Install NEST <installation/index>
tutorials/index
PyNEST example scripts <examples/index>


.. toctree::
:maxdepth: 1
:caption: Understand how NEST works

NEST models <models/models-main>
Neurons <neurons/index>
Synapses and connections <synapses/index>
Devices <devices/index>
Spatially-structured networks <networks/spatially_structured_networks>
Simulation behavior <nest_behavior/running_simulations>
Randomness in NEST <nest_behavior/random_numbers>
Built-in timers <nest_behavior/built-in_timers>
Connect NEST with other tools <connect_nest/index>
Parallel computing <hpc/parallel_computing>
Benchmarking <hpc/benchmarking>


.. toctree::
:maxdepth: 1
:caption: Reference material

Release notes <release_notes/index>
ref_material/pynest_apis
Model directory <models/index>
From NEST 2.x to 3.x <release_notes/v3.0/refguide_nest2_nest3>
Glossary <ref_material/glossary>

.. toctree::
:maxdepth: 1
:caption: Community

Get help <getting_help>
Contact us <community>
Contribute <developer_space/contribute>
Cite NEST <citing-nest>
Developer space <developer_space/index>
related_projects
News and updates <https://nest-simulator.org>
Publications <https://www.nest-simulator.org/publications/>
NEST Initiative <https://www.nest-initiative.org/>
license


Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _contribute:

Contributing to NEST
====================
Contribute to NEST
==================

NEST draws its strength from the many people that use and improve it. We
are happy to consider your contributions (e.g., new models, bug or
Expand All @@ -19,6 +19,8 @@ you need to send us a completed and signed
:download:`NEST Contributor Agreement <NEST_Contributor_Agreement.pdf>` to transfer your
copyright to the NEST Initiative before we can merge your pull request.

.. _issues:

Report bugs and request features
--------------------------------

Expand Down Expand Up @@ -71,3 +73,5 @@ Have a question?
----------------

If you want to get in contact with us, see our :ref:`community` page for ways you can reach us.


Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _sample_doc:

Main title of document
Expand Down
53 changes: 53 additions & 0 deletions doc/htmldoc/developer_space/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
.. _developer_space:

Developer space
===============

Here is all documentation pertaining to the development of NEST.
It is documentation for anyone needing to touch the code or documentation (also includes SLI, since it is more complex
and likely used by developers or very advanced users).


.. toctree::
:maxdepth: 1
:caption: Install from source

../installation/linux_install

.. toctree::
:maxdepth: 1
:caption: Workflows
:glob:

workflows/*


.. toctree::
:maxdepth: 1
:caption: Guidelines
:glob:

guidelines/*
guidelines/styleguide/styleguide
guidelines/styleguide/vim_support_sli


.. toctree::
:maxdepth: 1
:caption: Templates
:glob:

templates/*

.. toctree::
:maxdepth: 1
:caption: SLI docs
:glob:

sli_docs/index

.. toctree::
:maxdepth: 1
:caption: Doxygen output

doxygen/
16 changes: 16 additions & 0 deletions doc/htmldoc/developer_space/sli_docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _sli_doc:

SLI documentation
=================


.. toctree::
:maxdepth: 1

an-introduction-to-sli
first-steps
neural-simulations
objects-and-data-types
programming-in-sli
using-files-and-keyboard-input

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ reference
<https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_.

The NEST simulator documentation lives alongside its code. It is
contained in the ``doc/userdoc`` directory within the `NEST source
contained in the ``doc/htmldoc`` directory within the `NEST source
code repository <https://github.com/nest/nest-simulator>`_ on GitHub.

We work with `GitHub <https://www.github.com>`_ as a web-based hosting
Expand Down Expand Up @@ -97,11 +97,11 @@ directory where you ran ``cmake``)

make html

3. Preview files. They are located in ``doc/userdoc/html``
3. Preview files. They are located in ``doc/htmldoc/html``

.. code-block:: bash

browser doc/userdoc/html/index.html
browser doc/htmldoc/html/index.html

To install the documentation under ``<nest_install_dir>`` along with
the rest of NEST, the ``make html`` command can be followed by
Expand All @@ -122,10 +122,10 @@ Editing and creating pages
To edit existing `reStructuredText <https://thomas-cokelaer.info/tutorials/
sphinx/rest_syntax.html>`_ files or to create new ones, follow the steps below:

1. You can edit and/or add ``.rst`` files in the ``doc/userdoc`` directory using your
1. You can edit and/or add ``.rst`` files in the ``doc/htmldoc`` directory using your
editor of choice.

2. If you create a new page, open ``contents.rst`` in the ``doc/userdoc`` directory
2. If you create a new page, open ``contents.rst`` in the ``doc/htmldoc`` directory
and add the file name under ``.. toctree::``. This will ensure it appears on
the NEST simulator documentation's table of contents.

Expand Down
10 changes: 10 additions & 0 deletions doc/htmldoc/devices/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _device_index:

All about devices in NEST
=========================

.. toctree::
:maxdepth: 1
:glob:

*
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions doc/htmldoc/hpc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _hpc_index:

All about high performance computing
====================================

.. toctree::
:maxdepth: 1
:glob:

*

.. todo::

Add pinning threads and benchmarking documentation here.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions doc/htmldoc/models/models-main.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Models in NEST
==============


NEST provides a ton of models! Textbook standards like integrate-and-fire and Hodgkin-Huxley type models are available
alongside high quality implementations of models published by the neuroscience community.

* Discover :doc:`all the models in our directory <index>`

Need to create your own?

* Check out :doc:`NESTML <nestml:index>`, a domain-specific language supporting neuron and synapse models with a code generation backend that generates model code in C++ for NEST.
File renamed without changes.
13 changes: 13 additions & 0 deletions doc/htmldoc/nest_behavior/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _behavior_index:

How NEST works
==============


.. toctree::

built-in_timers
random_numbers
running_simulations
nest_server
using_nest_with_music
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _run_simulations:

How to run simulations
======================
Simulation behavior
===================

Time-driven and event-driven approaches
---------------------------------------
Expand Down
Loading