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

ReadTheDocs: Create a .readthedocs.yaml configuration file #1443

Closed
buhtz opened this issue Jun 14, 2023 · 2 comments · Fixed by #1444
Closed

ReadTheDocs: Create a .readthedocs.yaml configuration file #1443

buhtz opened this issue Jun 14, 2023 · 2 comments · Fixed by #1444

Comments

@buhtz
Copy link
Member

buhtz commented Jun 14, 2023

ReadTheDocs informed us that they need a .readthedocs.yaml file in each repository. The deadline is at 25th September 2023.

This is also related to our separate user-documentation repository.

It might be easy to achieve and I still have done this for my repos on Codeberg.org (but they are using pydoctor instead of sphinx).

@buhtz buhtz self-assigned this Jun 14, 2023
@buhtz buhtz added this to the upcoming release (1.3.4) milestone Jun 14, 2023
@buhtz
Copy link
Member Author

buhtz commented Jun 14, 2023

This is the original BIT dev-docu. There is layout problem in the sidebar and also in the footer (not shown here). The text do overflow into the content area.
image

I don't know the reason. I just switch to the Sphinx-ReadTheDocs theme which looks a bit like the old Python 2 docu.
Here is a testing-version of the new BIT docu with "Sphinx-RTD" theme.
image

I will prepare a PR with the yaml-file soon.

@aryoda
Copy link
Contributor

aryoda commented Jun 14, 2023

I just switch to the Sphinx-ReadTheDocs theme which looks a bit like the old Python 2 docu.
https://bit-testing-readthedocs.readthedocs.io/

Good decision, your testing version does work with my Firefox and looks very nice IMHO!

buhtz added a commit that referenced this issue Jun 14, 2023
Add configuration .readthedocs.yaml file as requested by ReadTheDocs.org. The file becomes mandatory in September 2023.

Close #1443
buhtz added a commit to bit-team/doc that referenced this issue Jun 26, 2023
Adding the .readthedocs.yaml file which will become mandatory by ReadTheDocs.
See bit-team/backintime#1443 and https://blog.readthedocs.com/migrate-configuration-v2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants