Skip to content

Update documentation build#38

Merged
benedekrozemberczki merged 6 commits intoAstraZeneca:mainfrom
cthoyt:add-docs-check
Jan 16, 2022
Merged

Update documentation build#38
benedekrozemberczki merged 6 commits intoAstraZeneca:mainfrom
cthoyt:add-docs-check

Conversation

@cthoyt
Copy link
Contributor

@cthoyt cthoyt commented Jan 14, 2022

Summary

This adds testing to make sure sphinx can build the docs properly (and also makes necessary updates)

  • Code passes all tests
  • Unit tests provided for these changes
  • Documentation and docstrings added for these changes

Changes

  • Add sphinx build check to CI
  • Move documentation build requirements into setup.py (remove docs/requirements_1.txt and update readthedocs.yml)
  • Use sphinx-automod-api to document groups of related things (datasets + models)
  • Make imports explicit
  • Removes custom CSS for now (until it can be updated to work both on local builds and also RTD)
  • Add doc8 and docstr-coverage test to make sure everything is documented :)

This adds testing to make sure sphinx can build the docs properly (and also makes necessary updates)
html_logo = "_static/img/chemicalx.jpg"
html_static_path = ["_static"]
html_context = {"css_files": ["_static/css/custom.css"]}
# html_context = {"css_files": ["_static/css/custom.css"]}
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 seemed to break the build locally but I guess it's working on RTD? I'd rather skip this since local testing is important

@benedekrozemberczki
Copy link
Contributor

This is amazing @cthoyt! The undeployed doc build checks were a pain before. Thank you for taking the time!

@benedekrozemberczki benedekrozemberczki merged commit b4e7c52 into AstraZeneca:main Jan 16, 2022
@cthoyt cthoyt deleted the add-docs-check branch January 16, 2022 23:56
@cthoyt
Copy link
Contributor Author

cthoyt commented Jan 16, 2022

This is definitely why it pays to have a project template that enforces this stuff from the beginning - it's a ton of busy work to get stuff back to working if you're not sure what broke it

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.

2 participants