Add Sphinx-based documentation system and supporting files. - #532
Closed
Lakshya-2440 wants to merge 3 commits into
Closed
Add Sphinx-based documentation system and supporting files.#532Lakshya-2440 wants to merge 3 commits into
Lakshya-2440 wants to merge 3 commits into
Conversation
Collaborator
Author
|
@sadamov neither of those PRs are completely correct or even completed, my PR is completed, have deployed a good documentation system |
Collaborator
|
@Lakshya-2440 i understand, could you bring up this topic at the next dev meeting? So far we tried to keep open only 2 prs to maintain some sense of structure (one docstrings, one autodocs). No duplicate PRs has been a core principle for us during GSoC so far. But several people have opened separate PRs on autodoc and I think the dev meeting would be the best place to align ourselves. |
This file contains hidden or 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
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.
Describe your changes
Added a complete Sphinx-based documentation system under docs/ with .rst files, Makefile, conf.py, and supporting scripts.
Included CONTRIBUTING.md and DOCUMENTATION_SETUP.md for contributor and documentation setup guidance.
Added scripts for documentation and example runs.
Issue Link
closes #61
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee