Skip to content

Conversation

@humitos
Copy link
Member

@humitos humitos commented Nov 11, 2025

Return the readthedocs_yaml_path field in the Project serializer for APIv3 and allow setting it as well.

Requested by a user at https://app.frontapp.com/open/cnv_1i8d4tuq

Return the `readthedocs_yaml_path` field in the Project serializer for
APIv3 and allow setting it as well.
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Nov 24, 2025
@humitos humitos moved this from Planned to In progress in 📍Roadmap Nov 24, 2025
@humitos
Copy link
Member Author

humitos commented Dec 1, 2025

@copilot please write a simple test case for this PR to check that setting Project.readthedocs_yaml_path is returned in the response.

Copy link
Contributor

Copilot AI commented Dec 1, 2025

@humitos I've opened a new pull request, #12621, to work on those changes. Once the pull request is ready, I'll request review from you.

@read-the-docs-community
Copy link

read-the-docs-community bot commented Dec 1, 2025

Documentation build overview

📚 docs | 🛠️ Build #30534108 | 📁 Comparing ee583db against latest (976aac4)


🔍 Preview build

Show files changed (24 files in total): 📝 21 modified | ➕ 0 added | ➖ 3 deleted
File Status
glossary.html 📝 modified
link-previews.html 📝 modified
visual-diff.html 📝 modified
api/v3.html 📝 modified
config-file/v2.html 📝 modified
guides/cross-referencing-with-sphinx.html 📝 modified
guides/deprecating-content.html 📝 modified
guides/intersphinx.html 📝 modified
guides/technical-docs-seo-guide.html 📝 modified
intro/antora.html 📝 modified
intro/doctools.html 📝 modified
intro/docusaurus.html 📝 modified
intro/markdoc.html 📝 modified
intro/mdbook.html 📝 modified
intro/mkdocs.html 📝 modified
intro/mystmd.html ➖ deleted
intro/sphinx.html 📝 modified
intro/vitepress.html 📝 modified
intro/zensical.html ➖ deleted
reference/main-content-detection.html ➖ deleted
server-side-search/index.html 📝 modified
tutorial/index.html 📝 modified
tutorials/index.html 📝 modified
guides/setup/monorepo.html 📝 modified

humitos and others added 2 commits December 1, 2025 10:15
- [x] Add `readthedocs_yaml_path` field to `ProjectSerializer` (read)
- [x] Add `readthedocs_yaml_path` field to `ProjectUpdateSerializerBase`
(write)
- [x] Add test case `test_partial_update_project_readthedocs_yaml_path`
to verify setting and getting the field via API
- [x] Keep the comment about YAML config file settings

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 We'd love your input! Share your thoughts on Copilot coding agent in
our [2 minute survey](https://gh.io/copilot-coding-agent-survey).

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: humitos <[email protected]>
@humitos humitos marked this pull request as ready for review December 1, 2025 09:41
@humitos humitos requested a review from a team as a code owner December 1, 2025 09:41
@humitos humitos requested a review from stsewd December 1, 2025 09:41
@humitos humitos enabled auto-merge (squash) December 1, 2025 09:55
Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

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

Documentation needs to be updated. We should also verify if validation is the same as one we do on the model and form.

@humitos humitos requested a review from a team as a code owner December 2, 2025 11:36
@humitos humitos requested review from agjohnson and stsewd December 2, 2025 11:36
@humitos
Copy link
Member Author

humitos commented Dec 2, 2025

I added the validation and update the docs.

@read-the-docs-community
Copy link

read-the-docs-community bot commented Dec 2, 2025

Documentation build overview

📚 dev | 🛠️ Build #30534107 | 📁 Comparing ee583db against latest (976aac4)


🔍 Preview build

Show files changed (1 files in total): 📝 1 modified | ➕ 0 added | ➖ 0 deleted
File Status
install.html 📝 modified

@humitos humitos moved this from In progress to Needs review in 📍Roadmap Dec 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Needs review

Development

Successfully merging this pull request may close these issues.

3 participants