Skip to content

Conversation

4n4nd
Copy link
Owner

@4n4nd 4n4nd commented Mar 22, 2019

Change method docstrings so that sphinx auto generates documentation for them.

@4n4nd 4n4nd requested a review from durandom March 22, 2019 14:10
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, seems that this is created by shpinx? Nevertheless, the question about the task runner still stands :)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@durandom durandom merged commit e767429 into 4n4nd:master Mar 22, 2019
@4n4nd
Copy link
Owner Author

4n4nd commented Mar 22, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants