Merge pull request #1569 from SpiNNakerManchester/doc_fix

Doc fix

Author: Christian-B

.readthedocs.yml

@@ -17,6 +17,11 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+  jobs:
+    post_build:
+      - cd neural_modelling; doxygen ./Doxyfile
+      - mkdir -p ${READTHEDOCS_OUTPUT}html/neural_modelling/
+      - cp -a neural_modelling/html/* ${READTHEDOCS_OUTPUT}html/neural_modelling/
 sphinx:
   configuration: doc/source/conf.py
   builder: dirhtml

doc/source/conf.py

@@ -93,16 +93,16 @@
 
 # General information about the project.
 project = 'sPyNNaker'
-copyright = '2014'
+copyright = '%Y The University of Manchester'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '6.0'
+version = 'development'
 # The full version, including alpha/beta/rc tags.
-release = '6.0.1'
+release = 'development'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/source/index.rst

@@ -1,6 +1,8 @@
 These pages document the python code for the sPyNNaker_ module
 which is part of the SpiNNaker_ Project.
 
+The neural_modelling_ module contains the documentation of the C code for this module.
+
 This code depends on SpiNNUtils_, SpiNNMachine_, SpiNNMan_, PACMAN_, SpiNNFrontEndCommon_
 (Combined_documentation_).
 
@@ -12,6 +14,7 @@ This code depends on SpiNNUtils_, SpiNNMachine_, SpiNNMan_, PACMAN_, SpiNNFrontE
 .. _PACMAN: https://pacman.readthedocs.io
 .. _SpiNNFrontEndCommon: https://spinnfrontendcommon.readthedocs.io
 .. _Combined_documentation: https://spinnakermanchester.readthedocs.io
+.. _neural_modelling: neural_modelling/
 
 sPyNNaker
 =========

neural_modelling/Doxyfile

@@ -52,7 +52,7 @@ PROJECT_NAME           = "sPyNNaker neural_modelling"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 7.3.1
+PROJECT_NUMBER         = development
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

neural_modelling/mainpage.dox

@@ -59,8 +59,6 @@
 *
 * These enable the neuron simulation to work, or to work more efficiently.
 *
-* * Bitfield Expander, which builds inter-core message masks on the machine.
-*   See bit_field_expander.c
 * * Delay Extension, which handles messages that need to be delayed a long time
 *   before delivery. See delay_extension.c
 * * Robot Motor Control, which translates spiking rates of SpiNNaker messages