add sphinx doc [WIP] #1557
Closed
add sphinx doc [WIP] #1557
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
initial documentation
|
Could 21d2ccd be three separate PRs? (code of conduct, issue template, PR template) I imagine there will be discussion about each individually |
sure |
fnielsen
added a commit
that referenced
this pull request
Feb 16, 2022
A pull requests #1557 has added a files for Sphinx documentation generation. The commit takes some of the changes from the PR as well as add a configuration for readthedocs. Some changes was made to the files from the PR: Style and which files to include in the documentation.
10 tasks
fnielsen
added a commit
that referenced
this pull request
Feb 16, 2022
A pull requests #1557 has added a files for Sphinx documentation generation. The commit takes some of the changes from the PR as well as add a configuration for readthedocs. Some changes was made to the files from the PR: Style and which files to include in the documentation.
|
The changes have been edited into the PR #1849 and the documentation is now running at https://scholia.readthedocs.io/en/latest/ |
|
Adding a pointer to which serves to keep an overview of things we worked on during the hackathon. |
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.
add Scholia documentation using Sphinx
I have created a first approximation of the Scholia documentation, although there is already a Contributing to Scholia file, I would like something to be created as an introduction to the project, maybe you can help me with that, also if something should be corrected in the contributing it is time to make the changes.
A good tool for generating notes is ArchiveBox maybe you can check it out.
You can check the documentation in docs/_build/html/index.html
I add the code of conduct using the contributor-covenant template with this licence