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

fix: Update RTD config. #418

Closed
wants to merge 1 commit into from
Closed

Conversation

dianakhuang
Copy link
Contributor

@dianakhuang dianakhuang commented Dec 6, 2023

RTD updated their config format. This updates
the cookiecutter to match their recommendations.

#416

Merge checklist:
Check off if complete or not applicable:

  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, deadlines, tickets

@dianakhuang dianakhuang force-pushed the diana/update-rtd-config branch from 56e10e6 to 0b3d881 Compare December 6, 2023 19:35
CHANGELOG.rst Outdated Show resolved Hide resolved
@dianakhuang dianakhuang force-pushed the diana/update-rtd-config branch from c60507b to 5eb7e4b Compare December 6, 2023 19:39
- method: pip
path: .
Copy link
Contributor

Choose a reason for hiding this comment

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

@dianakhuang: Did you find any information about this, or are you just following what was done in edx-platform?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was just following what was done in edx-platform under the assumption that getting a working RTD config was more important than worrying about whether we may have redundant config.

Copy link
Contributor

Choose a reason for hiding this comment

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

FYI, this is needed in edx-platform because we have to pip install . in order to add all the plugin entrypoints that edx-platform needs to properly start up django. Which we do to generate the module docs now. We shouldn't generally need this in other repos.

os: "ubuntu-22.04"
tools:
python: "3.8"

python:
version: 3.8
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you want to remove this redundant version declaration.

RTD updated their config format. This updates
the cookiecutter to match their recommendations.

#416
@dianakhuang dianakhuang force-pushed the diana/update-rtd-config branch from 5eb7e4b to 3b1eb8c Compare December 6, 2023 19:49
@dianakhuang
Copy link
Contributor Author

Closing as a dupe of #419

@dianakhuang dianakhuang closed this Dec 6, 2023
@dianakhuang dianakhuang deleted the diana/update-rtd-config branch December 6, 2023 20:28
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.

4 participants