Setup sphinx documentation#7
Merged
JaroCamphuijsen merged 12 commits intomainfrom May 6, 2026
Merged
Conversation
JaroCamphuijsen
force-pushed
the
5-documentation-infra
branch
from
b9c53ac to
5528cb9
Compare
added 2 commits
April 21, 2026 16:39
added 3 commits
April 21, 2026 17:05
Member
Author
|
I also added a workflow to build the documentation while I was at it |
Member
Author
|
I had a quick look at using meson to build the documentation, but it would not make things a lot simpler than they already are. At the moment it is only two or three steps to build the docs locally and/or in the github workflow. We can always integrate it if things become more complex or if we think it is better. |
cantordust
approved these changes
May 6, 2026
Member
cantordust
left a comment
cantordust
left a comment
There was a problem hiding this comment.
Awesome - the documentation builds and looks great!🚀 I just made some suggestions on the text, I'll leave it up to you to decide if you want to accept them.🙂
Thanks for the review! These were all reasonable suggestions. Most of the text in "introduction.md" actually came from the referenced paper, so the text fixes should be in there. For me this is a placeholder anyway, as I think Eva and/or Bandan should write these parts. For now i just accepted your contributions, which made it more readable. Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fix #5
fix #6
Follow the instructions in
README.dev.mdto build the documentation locally.and/or have a look at https://nlesc.github.io/corticalsim3D/