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

find out how to push the documentation to rtd online. #51

Open
1 of 6 tasks
laszewsk opened this issue Oct 7, 2022 · 2 comments
Open
1 of 6 tasks

find out how to push the documentation to rtd online. #51

laszewsk opened this issue Oct 7, 2022 · 2 comments
Assignees
Labels
4 documentation Improvements or additions to documentation enhancement New feature or request

Comments

@laszewsk
Copy link
Member

laszewsk commented Oct 7, 2022

  • set up minimal publication of sphinx on rtd https://cloudmesh-cc.readthedocs.io/en/latest/
  • set up publishing in rtd openapi
  • set up publishing openapi.json on rtd via sidebar
  • set up publishing openapi.yml on rtd via sidebar
  • check if other pages are missing
  • figure out how to properly publish the API modules instead of having them duplicated in generated and the . dir

SHoudl the files openapi3.html, openapi.json and openapi.yam lbe duplicated from ./ to docs/source. THis will have to be done in the makefile and make doc will do that . Then I assume it will be available in rtd as it may be copied from source?

@laszewsk laszewsk added enhancement New feature or request 4 labels Oct 7, 2022
@laszewsk
Copy link
Member Author

laszewsk commented Oct 7, 2022

placement of the openapi files in docs/sources did not work

@laszewsk
Copy link
Member Author

laszewsk commented Oct 7, 2022

The problems seems to be teh replicated rst files in generated and the main repo. This does not allow for some reason to display the automatic generated documentation to display in rtd just as it did not in the local dir.

So we generate the apis wrong in some fashion ...

@laszewsk laszewsk added the documentation Improvements or additions to documentation label Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants