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

Improve overview of online documentation with autosummary #2931

Merged
merged 2 commits into from
Dec 14, 2023

Conversation

jorgensd
Copy link
Sponsor Member

@jorgensd jorgensd added documentation Documentation improvements or fixes backport? Suggest PR for backporting labels Dec 14, 2023
@francesco-ballarin
Copy link
Member

(Partially OT): except for maybe dolfinx/__init__.py, do we need __all__ in the other submodules? It gets populated by default with everything that gets imported in the __init__.py file.

@jorgensd
Copy link
Sponsor Member Author

(Partially OT): except for maybe dolfinx/__init__.py, do we need __all__ in the other submodules? It gets populated by default with everything that gets imported in the __init__.py file.

We need __all__ for autosummary to work.

@jorgensd
Copy link
Sponsor Member Author

There are also functions that we import that we do not want to expose (such as helper functions, external imports etc).

@jhale jhale added this pull request to the merge queue Dec 14, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 14, 2023
@jorgensd jorgensd added this pull request to the merge queue Dec 14, 2023
Merged via the queue into main with commit 552918c Dec 14, 2023
19 checks passed
@jorgensd jorgensd deleted the dokken/expose_autosummary_for_all branch December 14, 2023 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport? Suggest PR for backporting documentation Documentation improvements or fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants