Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup the docs on ReadTheDocs.org #62

Merged
merged 11 commits into from
Jan 8, 2018
Merged

Setup the docs on ReadTheDocs.org #62

merged 11 commits into from
Jan 8, 2018

Conversation

pior
Copy link
Member

@pior pior commented Jan 4, 2018

  • Add a Sphinx documentation with:
    • minimal landing page
    • automatic API documentation with autodoc
  • Document the doc build process

Doc temporarily build from this branch : https://py-oozie.readthedocs.io/

This is a first step to resolves #8.

@pior pior requested a review from cfournie January 4, 2018 22:28
Copy link
Contributor

@cfournie cfournie left a comment

Choose a reason for hiding this comment

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

Minor comment, otherwise LGTM

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Copy link
Contributor

Choose a reason for hiding this comment

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

Although this is likely auto-generated, can you add a terminating newline?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add restructured text documentation and docstrings to all public APIs
2 participants