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

Modify and improve colors in style sheet for user documentation #2082

Merged
merged 7 commits into from
Jul 20, 2021

Conversation

jessica-mitchell
Copy link
Contributor

This PR modifies the CSS to change the color/highlighting of different items on ReadtheDocs.
These changes remove the default blue theme color that crept in our docs in some places, and tries to improve the clarity by removing background colors.

It also hides the entire name of python objects (so instead of nest.lib.hl_api_simulation.Simulate() being shown only Simulate() is visible) in the PyNEST API.

Of course, these changes can be discussed and modified.

Resolves #2031

@jessica-mitchell jessica-mitchell added I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation labels Jun 29, 2021
Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

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

I'm happy with these changes and will merge them.

@jougs jougs removed the request for review from steffengraber July 20, 2021 18:27
@jougs jougs changed the title Modify CSS to improve color style on ReadtheDocs Modify and improve colors in style sheet for ReadtheDocs Jul 20, 2021
@jougs jougs merged commit f517fc1 into nest:master Jul 20, 2021
@terhorstd terhorstd changed the title Modify and improve colors in style sheet for ReadtheDocs Modify and improve colors in style sheet for user documentation Sep 15, 2021
@jessica-mitchell jessica-mitchell deleted the fix-css-docs branch November 19, 2021 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Fix up colour and style of HTML output (mainly PyNEST APIs)
2 participants