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

Auto generate documentation include sphinx apidoc run #287

Merged
merged 4 commits into from
Jun 28, 2019

Conversation

juhoinkinen
Copy link
Member

This allows running sphinx-apidoc automatically when sphinx-build runs in RTD, thus there is no need to the .rst files docs/source/.

@codecov
Copy link

codecov bot commented Jun 28, 2019

Codecov Report

Merging #287 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #287   +/-   ##
=======================================
  Coverage   99.32%   99.32%           
=======================================
  Files          52       52           
  Lines        2651     2651           
=======================================
  Hits         2633     2633           
  Misses         18       18

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 cc47afa...dc00e3e. Read the comment docs.

@osma
Copy link
Member

osma commented Jun 28, 2019

#285 was just merged. Should this be adjusted accordingly? #285 dropped the requirements.txt file, but this PR seems to be changing it...

Other packages needed for the RTD build are in setup.py (maybe this
could be there too, but seems unnecessary)
@juhoinkinen
Copy link
Member Author

sphinxcontrib-apidoc needed to be installed, but adding it to setup.py seemed unnecessary(?). It's now in specific file in docs/requirements.txt.

Not optimal, but hopefully Pipfile support is coming soon in RTD, so the whole build dependency handling becomes more simple via it.

@juhoinkinen juhoinkinen marked this pull request as ready for review June 28, 2019 14:05
@osma
Copy link
Member

osma commented Jun 28, 2019

Much better now! I don't see a problem having a single-line docs/requirements.txt file specifically for RTD, since it doesn't duplicate dependency information in setup.py and Pipfile.

@osma osma merged commit 09c4084 into master Jun 28, 2019
@osma osma added this to the v0.41 milestone Jul 5, 2019
@juhoinkinen juhoinkinen deleted the auto-generate-documentation-include-sphinx-apidoc-run branch August 15, 2019 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants