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

docs: update .readthedocs.yaml #415

Merged
merged 3 commits into from
Dec 12, 2023
Merged

docs: update .readthedocs.yaml #415

merged 3 commits into from
Dec 12, 2023

Conversation

robrap
Copy link
Contributor

@robrap robrap commented Dec 6, 2023

Description:

Following cookiecutter recommendations in this update: bb2b783

  • Rename .readthedocs.yml to .readthedocs.yaml
  • Remove extra python install lines from edx-platform
  • Add fail_on_warning to protect against doc issues

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Commits are squashed

Following cookiecutter recommendations in this update:
bb2b783

- Rename .readthedocs.yml to .readthedocs.yaml
- Remove extra python install lines from edx-platform
- Add fail_on_warning to protect against doc issues
@feanil
Copy link
Contributor

feanil commented Dec 7, 2023

It looks like this repo does need to install . because it's making use of the automodule feature for documentation. Most of our repos aren't using this and not all repos are pip installable so it might not make sense as a part of the default but also it makes sense here.

.readthedocs.yaml Outdated Show resolved Hide resolved
@robrap
Copy link
Contributor Author

robrap commented Dec 11, 2023

@feanil: Any interest in fixing up fail_on_warning issues? Otherwise, I'm going to close this PR and move on to other things. Not sure that the file rename really matters.

@feanil
Copy link
Contributor

feanil commented Dec 12, 2023

yea, I'll take a look

* Document the correct module (auth instead of authentication.)

* Include the ADRs in the documentation.

* Update a docstring that Sphinx had trouble parsing.
@feanil feanil force-pushed the robrap/fix-reathedocs-config branch from f8ca038 to a057026 Compare December 12, 2023 14:13
@feanil
Copy link
Contributor

feanil commented Dec 12, 2023

This is fixed now, just needs codcov to recieve the coverage info and then it should be good to merge.

@robrap robrap merged commit b94863c into master Dec 12, 2023
7 checks passed
@robrap robrap deleted the robrap/fix-reathedocs-config branch December 12, 2023 15:46
@robrap
Copy link
Contributor Author

robrap commented Dec 12, 2023

@feanil: Thank you!

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