Skip to content

Revise documentation (incl. alignment with NEST simulator) - #138

Open
jhnnsnk wants to merge 46 commits into
nest:mainfrom
jhnnsnk:doc/align-with-nest-simulator
Open

Revise documentation (incl. alignment with NEST simulator)#138
jhnnsnk wants to merge 46 commits into
nest:mainfrom
jhnnsnk:doc/align-with-nest-simulator

Conversation

@jhnnsnk

@jhnnsnk jhnnsnk commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Current preview: https://jhnnsnknest-gpu.readthedocs.io

  • Align overall file structure with NEST simulator, e.g., from doc/ to doc/htmldoc, and update build instructions, e.g., requirements.txt
  • Align overall appearance, e.g., using sphinx_material theme, and adjust style files; also add favicon
  • New NEST GPU-specific banner (network to "GPU cluster" transition) with Python script for generation and checked-in .svg file
  • Organise Navigation into USAGE, COMMUNITY, and RELATED PROJECTS
  • Landing page with new introductory text and Highlights carousel
  • Add refs.bib as bibliography for the whole documentation
  • Add new page "Publications" that shows each NEST GPU paper with its citation, a teaser figure and some key points
  • Add a new guide on Connectivity concepts building on the NEST simulator version
  • Revise installation instructions
  • Add new page "Cite NEST GPU"
  • Add new page "Contact us and contribute" emphasizing joint development with NEST simulator; replace old content partially from current version of NEST simulator
  • Add new page "What's new?" linking to the GitHub release notes
  • RELATED PROJECTS now shows NEST simulator and NESTML (the functionality to generate neuron models with NESTML is also mentioned in the Model Directory and the guide for implementing new neuron models)
  • Add license
  • Add 404 not found page

(coding partially assisted by Claude)

jhnnsnk added 30 commits July 31, 2026 23:53
@jhnnsnk
jhnnsnk requested review from JoseJVS and gmtiddia August 5, 2026 17:52
@jhnnsnk
jhnnsnk marked this pull request as draft August 5, 2026 17:52
@jhnnsnk
jhnnsnk requested a review from golosio August 5, 2026 17:53
@jhnnsnk
jhnnsnk marked this pull request as ready for review August 11, 2026 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant