Add instructions for generating API documentation #2
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
|
@GavinHuttley, do you want to review this one? |
|
|
||
| API documentation can be generated by running `pdoc cogent --html --html-dir=/path/to/output` at the command line (replacing the `/path/to/output` with your desired output path). | ||
|
|
||
| If you don't have `pdoc` installed, first run `pip install pdoc`. |
There was a problem hiding this comment.
Users may need to sudo that command, please update to reflect that. Otherwise, looks good and thanks!
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.
I've added noob instructions for generating API documentation to the readme. I put them here because I would have found them myself if they were here, but I recognize it may not be the best place.
❤️ PyCogent