Skip to content

Include part of README into docs #77

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

Closed
webknjaz opened this issue Nov 1, 2018 · 4 comments
Closed

Include part of README into docs #77

webknjaz opened this issue Nov 1, 2018 · 4 comments

Comments

@webknjaz
Copy link

webknjaz commented Nov 1, 2018

Docs https://docs.readthedocs.io/en/latest/yaml-config.html#build-image don't list everything present in the README of this repo.

I suggest using partial inclusion to synchronize them: https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/.

@stsewd
Copy link
Member

stsewd commented Nov 1, 2018

Do you mean 1.0 and 4.0rc images? We don't support those yet on rtd

@stsewd
Copy link
Member

stsewd commented Nov 1, 2018

Also, the yaml config docs are located in another repo https://github.com/rtfd/readthedocs.org/tree/master/docs

@webknjaz
Copy link
Author

webknjaz commented Nov 1, 2018

Probably 3.0 as well (not stated that it's latest)...

@stsewd
Copy link
Member

stsewd commented Nov 1, 2018

Yeah, we are planning to change numbered versions to just stable and latest #62

@webknjaz webknjaz closed this as completed Nov 1, 2018
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

No branches or pull requests

2 participants