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

Numerous documentation build warnings #844

Open
Zeitsperre opened this issue Nov 20, 2023 · 0 comments
Open

Numerous documentation build warnings #844

Zeitsperre opened this issue Nov 20, 2023 · 0 comments

Comments

@Zeitsperre
Copy link
Collaborator

There are a lot of documentation build warnings (~230 at time of writing).

The majority of these are due to multiple targets being produced (sphinx-autodoc alongside user-generated API documentation; requires that one of these be given the attribute of :noindex:). The remaining ones require a keen eye (small typos in docstrings, formatting issues, etc.), or they require some structural decisions with the documentation (pages/notebooks not indexed in the docs that are either should be ignored or added).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant