Adds initial Docs Proof of concept#84
Open
darigovresearch wants to merge 6 commits into
Open
Conversation
Contributor
Author
|
@kerrickstaley is there anything else that is required for this pull request to be merged? |
Contributor
Author
|
@kerrickstaley do you need anything else to merge this pull request? |
Resolves kerrickstaley#138 if merged
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
1 participant
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.
An initial attempt at creating docs of the current documentation using readthedocs has been created and can be viewed at the link below
If merged you need to enable GitHub pages on the
docsfolder (happy to do this if given the correct permissions).This pull request just contains an initial port of what is highlighted in the readme, the main item that wasn't able to figure out was how to put a link on an inline piece of code
https://darigovresearch.github.io/genanki/build/html/index.html
Relevant to issues #76 and 74
@kerrickstaley this may help as a first step to adapt/autogenerate the docstrings & more