Add Sphinx Documentation configuration#3
Merged
Conversation
durandom
approved these changes
Mar 22, 2019
| @@ -0,0 +1,19 @@ | |||
| # Minimal makefile for Sphinx documentation | |||
Contributor
There was a problem hiding this comment.
@fridex is there a preferred task runner in the python community? Right now we're using Makefile for most of our stuff, because I'm old
Contributor
There was a problem hiding this comment.
Ah, seems that this is created by shpinx? Nevertheless, the question about the task runner still stands :)
There was a problem hiding this comment.
In thoth we use something like:
python3 setup.py build_sphinx
Sphinx needs to be installed, the command above looks for doc or docs directory with sources
Owner
Author
|
Oh cool 👍, I will change it in the next PR.ThanksOn Mar 22, 2019 3:16 PM, Fridolín Pokorný <notifications@github.com> wrote:@fridex commented on this pull request.
In docs/Makefile:
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
https://www.sphinx-doc.org/en/master/usage/advanced/setuptools.html
https://github.com/thoth-station/nepthys/blob/master/create_docs.sh
https://github.com/thoth-station/adviser/blob/c68cd3841684380cfb3ba2468b5c3976938d6e84/setup.py#L64
—You are receiving this because you authored the thread.Reply to this email directly, view it on GitHub, or mute the thread.
|
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
3 participants
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.
Change method docstrings so that sphinx auto generates documentation for them.