Documentation workflow added #236
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
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.
.github/workflows/sphinx.yml.requirements.txt(used in the docs workflow) which specifies the main packages of dicee as well as the packages needed to build and format the documentation.docs\usagethat holds .md files (that may contain descriptions, guides, tutorials, etc.) which can be displayed in the documentation.docs\usage\main.mdwhich contains the content ofREADME.mdsphinx-autoapilibrary will take care of automatic documentation that is sourced from docstrings.Docs are deployed to gh-pages which is used as an indexing branch for GitHub Pages