Skip to content

feat: documentation genereated on orphan branch #89

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

Merged
merged 21 commits into from
Sep 9, 2021

Conversation

tallpress
Copy link
Contributor

dupe of #75, however not a folk

This is how the docs will appear https://eva-python-sdk-testing.readthedocs.io/en/feature-documentation/evasdk.html url will change
Changes

adds Spinx dep. to create documentation. Installs Sphinx dep to generate module documentation https://www.sphinx-doc.org/en/master/
adds dep. m2r2 to Sphinx include README.md in the docs https://crossnox.github.io/m2r2/
adds .readthedocs.yaml, which should mean that RTD can read and build our docs with Sphinx.
removes badges from README.md heading as it was messing with the table of contents
adds RTD automation step that will automatically build semver tagged versions of the SDK's documentation

@codecov-commenter
Copy link

codecov-commenter commented Sep 3, 2021

Codecov Report

Merging #89 (e69d130) into development (441ae6a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           development      #89   +/-   ##
============================================
  Coverage        35.07%   35.07%           
============================================
  Files               10       10           
  Lines              710      710           
  Branches           111      111           
============================================
  Hits               249      249           
  Misses             454      454           
  Partials             7        7           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 441ae6a...e69d130. Read the comment docs.

docs/evasdk.rst Outdated
@@ -0,0 +1,93 @@
evasdk package
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to include those or are they auto-generated? Do we keep them so we can edit them and add more docs? Is that something we can do with docstring on the package itself?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is generated, most are generated, this is what sphinx uses to generate the docs off of the docstrings and set up the display of the documentation. However, there are a few custom ones, such as example.rst index.rst and readme.rst

Copy link
Contributor

Choose a reason for hiding this comment

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

My point is: can we avoid these custom ones through docstrings? Can we remove any autogenerated one?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we need the index.rst and modules.rst. I think it's useful for the docs to include the readme, hence the readme.rst, and also nice to show the examples, hence examples.rst. However happy to remove all that if you don't want it. Regarding the generated files, we can remove evasdk.rst and setup.rst if you like, i guess they aren't necessarily required anymore now that we are building the docs on an orphan branch.

Copy link
Contributor

Choose a reason for hiding this comment

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

readme.rst I can understand, examples.rst I don't love but it's alright, why do the others do?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

index.rst is the glue. modules.rst means we display the module documentation, it effectively tells the Sphinx autodoc tool "hey look, use the to generate docs off of these modules"

@LouisBrunner
Copy link
Contributor

What about development version of the docs? Does that come in a latter PR?

@tallpress
Copy link
Contributor Author

What about development version of the docs? Does that come in a latter PR?

good point, I can add in another PR, or add in this PR, up to you. It would be a matter of also running this workflow (or similar one with hardcoded docs/development) to also run when merging into development.

docs/evasdk.rst Outdated
@@ -0,0 +1,93 @@
evasdk package
Copy link
Contributor

Choose a reason for hiding this comment

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

My point is: can we avoid these custom ones through docstrings? Can we remove any autogenerated one?

@LouisBrunner LouisBrunner merged commit 2ad78a5 into development Sep 9, 2021
@LouisBrunner LouisBrunner deleted the feature/docs branch September 9, 2021 13:33
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.

3 participants