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

Doc upgrades #2229

Merged
merged 19 commits into from
Dec 22, 2023
Merged

Conversation

thorstenhater
Copy link
Contributor

@thorstenhater thorstenhater commented Oct 19, 2023

  • Polish & modernise two cells + gap junction example.
  • Investigate problems with mathjax
  • Update spike data format docs.
  • Switches theme to FURO, which is better maintained and document (like ... at all)
    • with the new theme, we gain dark mode, yet we need to fix our graphics to make it a really nice experience.

Fixes #2227
Fixes #2228

@thorstenhater thorstenhater requested a review from Helveg October 23, 2023 12:26
@thorstenhater thorstenhater marked this pull request as ready for review October 24, 2023 06:53
@AdhocMan AdhocMan self-assigned this Nov 28, 2023
Copy link
Contributor

@AdhocMan AdhocMan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!
As you mentioned, some images still need work.
These are the ones, where I've found issues with the dark theme:

For the html based figures, it should be enough to change the text color to always be black. Maybe through some styling option specific to each div class?
The SVG figures could be fixed by setting the background to always be white. There appear to be ways to enforce this directly inside the SVG file.

doc/python/simulation.rst Outdated Show resolved Hide resolved
@thorstenhater
Copy link
Contributor Author

@AdhocMan thanks for putting in the leg work and finding those issues. Should be all good now.

Copy link
Contributor

@AdhocMan AdhocMan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great now!

@AdhocMan AdhocMan merged commit d4579b1 into arbor-sim:master Dec 22, 2023
23 checks passed
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.

Signature of spike structure is lacking some explanation Math not rendering in docs
2 participants