[Documentation] Refactor documentation #257
Merged
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
added 7 commits
December 3, 2024 13:08
…original publication/package
mschwoer
approved these changes
Dec 6, 2024
| @@ -0,0 +1,41 @@ | |||
| Installation | |||
There was a problem hiding this comment.
This now has some redundancies with the Readme.md. If you want to follow-up, you can have a look at the structure of https://github.com/MannLabs/alphadia?tab=readme-ov-file#installation where we had the same problem.
There was a problem hiding this comment.
Will address this in another pull request 👍
…etup of conda environment, updated installation instructions for development version
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.
Restructure
alphabasedocumentationThis pull request
Adds installation instructions (
[...]/docs/installation.rst)Adds a API documentation for all modules (
[...]/docs/api.rst)Adds references (
[...]/docs/references.rst)Restructures index page (add links to installation, API documentation, notebooks, references), adds description + reference.
Index
Old
New
API
New