-
Notifications
You must be signed in to change notification settings - Fork 631
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
Add sphinx docs #12
Add sphinx docs #12
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apart from the comment LGTM, but of course this can only be merged once the dependent #11 is merged.
docs/opentelemetry.api.rst
Outdated
--------------- | ||
|
||
.. automodule:: opentelemetry.api | ||
:members: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since these options seem to be the same everywhere, they should be added to the configuration https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
Co-Authored-By: Christian Neumüller <cn00@gmx.at>
…n into tracer-api-init
I updated the |
and remove generated API docs other than opencensus.trace.
I update the docs for the package move in #21 and removed a lot of the generated API doc boilerplate. After the package move autodoc generates empty docs for the new empty packages from #19, I removed these by hand. I also moved the |
This PR adds sphinx boilerplate for generating API docs. Most files are generated with
sphinx-quickstart
andsphinx-apidoc
with few changes.This branch builds on #11, I'll rebase as it's updated.
You can build the html docs from this branch as:
pip install sphinx sphinx_autodoc_typehints sphinx_rtd_theme sphinx-quickstart sphinx-apidoc --force -e -o docs opentelemetry (cd docs; make html)
I also pushed the generated html docs to the
sphinx-docs-built
branch, which you can check out to view the docs without building them yourself.