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

cleanup documentation #2007

Merged
merged 8 commits into from
Oct 25, 2022
Merged

cleanup documentation #2007

merged 8 commits into from
Oct 25, 2022

Conversation

boeschf
Copy link
Contributor

@boeschf boeschf commented Oct 19, 2022

fixes a bunch of sphinx warnings

Copy link
Contributor

@brenthuisman brenthuisman left a comment

Choose a reason for hiding this comment

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

Thanks! Few small points:

@@ -4,6 +4,7 @@ Cable cell probing and sampling
===============================

.. module:: arbor
:noindex:
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure this should be here? There are currently definitely links to these elements.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The module is already indexed in doc/python/cell.rst

Copy link
Contributor

Choose a reason for hiding this comment

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

I thought this directive also excludes all that follows. Did you check that it does not break links to stuff in this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think that this is the case, I do not get warnings about missing links, and the html doc still shows the option to make permalinks for the following entries/sections

@brenthuisman brenthuisman merged commit 4988431 into arbor-sim:master Oct 25, 2022
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.

2 participants