-
Notifications
You must be signed in to change notification settings - Fork 90
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
Restructure Documentation #1679
Open
MarcelKoch
wants to merge
7
commits into
ginkgo-project:develop
Choose a base branch
from
MarcelKoch:read-the-docs
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
ginkgo-bot
added
reg:build
This is related to the build system.
reg:documentation
This is related to documentation.
mod:core
This is related to the core module.
type:solver
This is related to the solvers
type:preconditioner
This is related to the preconditioners
type:matrix-format
This is related to the Matrix formats
type:factorization
This is related to the Factorizations
labels
Sep 12, 2024
Link to the documentation at RTD: https://ginkgo-test.readthedocs.io/en/read-the-docs/ |
MarcelKoch
force-pushed
the
read-the-docs
branch
5 times, most recently
from
September 13, 2024 09:02
251d914
to
02a4a81
Compare
This does the following things: - add sphinx to create non-reference/api documentation - move doxygen stuff into a subdirectory of the sphinx configuration - enable read-the-docs to host documentation
The linop group is often added with other groups. These other groups are mostly subgroups of linop, so there is no need to specify it twice.
MarcelKoch
force-pushed
the
read-the-docs
branch
from
September 13, 2024 09:06
02a4a81
to
b54adfb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
1:ST:ready-for-review
This PR is ready for review
mod:core
This is related to the core module.
reg:build
This is related to the build system.
reg:documentation
This is related to documentation.
type:factorization
This is related to the Factorizations
type:matrix-format
This is related to the Matrix formats
type:preconditioner
This is related to the preconditioners
type:solver
This is related to the solvers
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 PR splits the documentation into a part that is generated by sphinx and one that is generated by doxygen.
The doxygen part will cover only the reference API documentation, and anything else will be left to sphinx. The full separation is not done in this PR.
Changes:
usr
doc is available, thedev
doc is removed. IMO there is no need for adev
doc, since we can expect developers to look into the Ginkgo source code and discover the documentation there.TODO: