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 the readthedocs integration for PRs in this repo #636

Merged
merged 1 commit into from
Feb 17, 2025

Conversation

wmamills
Copy link
Collaborator

Upstream Read The Docs has tightened up the schema checking and this broke what we were doing for PRs.

A good number of things were tried but the best compromise is to:

  • supply a dummy sphinx config file in this repo
  • override the default build command to use the openamp-docs dir

Also:

  • add more documentation about what is going on
  • lock to html only format. PRs only do html anyway but make sure

Upstream Read The Docs has tightened up the schema checking and this broke
what we were doing for PRs.

A good number of things were tried but the best compromise is to:
* supply a dummy sphinx config file in this repo
* override the default build command to use the openamp-docs dir

Also:
* add more documentation about what is going on
* lock to html only format.  PRs only do html anyway but make sure

Signed-off-by: Bill Mills <[email protected]>
@wmamills wmamills self-assigned this Feb 15, 2025
@wmamills wmamills requested a review from arnopo February 15, 2025 14:34
@wmamills
Copy link
Collaborator Author

@arnopo this is basically a copy of the libmetal one with only the dir name changed.
It should be OK

@arnopo arnopo merged commit 00e0d7a into OpenAMP:main Feb 17, 2025
5 checks passed
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