feanil/update rtd docs #208
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This format of config in the repo will be required starting in september so add it now in preparation for that.
We need to actually setup django and its requirements to be able to render autodocs.
Some of the docstrings were throwing warnings when we were trying to render them in the docs site. Update the docstrings so they don't throw warnings.
feanil
force-pushed
the
feanil/update_rtd_docs
branch
from
588f5f4
to
9844039
Compare
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #208 +/- ##
=======================================
Coverage 93.43% 93.43%
=======================================
Files 18 18
Lines 1995 1995
Branches 130 130
=======================================
Hits 1864 1864
Misses 118 118
Partials 13 13
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
|
Everything looks good, but could you add some context for these changes? e.g., what's the desired end state we're going for? Looking at https://github.com/openedx/edx-submissions/tree/master/docs/source, this repo contains no RST docs. So, is the point of this to be able to publish docstrings on docs.openedx.org or elsewhere? |
|
@kdmccormick ah, thanks, yeas added some context to the PR description. It kind of snowballed from dealing with a deprecation on the RTD side. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This repo has a ReadTheDocs project that is currently broken, in making fixes for an upcoming RTD config deprecation, I noticed there were other issues with this repo. Rather than dropping this from RTD, I'm fixing forward so that this repo has docs that are in compliance with our latest standards and that will not have issues with the RTD config deprecation late next month.
make upgrade