Revert "Docs: Don't include boutdata/boututils in docs" #2881
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit e6bc5c5. The commit tried to make boutuitls and boutdata non-importable for the documentation tool. If those modules should be remove from the documentation, this can be achieved by removing them from manual/sphinx/_apidoc/. This should not break the documentation fro boutpp or boutconfig.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This reverts commit e6bc5c5.
The commit tried to make boutuitls and boutdata non-importable for the documentation tool. If those modules should be remove from the documentation, this can be achieved by removing them from manual/sphinx/_apidoc/. This should not break the documentation fro boutpp or boutconfig.
This resolves my last outstanding comment for #2844
@ZedThree I can also remove the boututils/boutdata documentation, if you think this is useful, but a quick search for boutdata doc lists the bout-dev as first result. If there is some other documentation on the web, it is not easily findable, except via boutpy, but that is a python2 fork of boutdata/boututils ...