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

Overhaul documentation infrastructure #346

Merged
merged 1 commit into from
Jun 9, 2021
Merged

Overhaul documentation infrastructure #346

merged 1 commit into from
Jun 9, 2021

Conversation

amotl
Copy link
Member

@amotl amotl commented Jun 2, 2021

Hi there,

this patch modernizes the documentation subsystem.

  • Get rid of buildout
  • Use "crate-docs" build system
  • Add ".readthedocs.yml"
  • CI: Run link checker on PRs and each night
  • Fix broken links
  • Get rid of mentioning the "enterprise" version
  • Add "installation" section to README.rst
  • Add badges

It is thought to support crate/crate-docs-theme#294 and should only be merged after crate/crate-docs-theme#295. It will resolve #327.

With kind regards,
Andreas.

@amotl
Copy link
Member Author

amotl commented Jun 7, 2021

Hi @norosa,

at crate/croud#334 (review), you mentioned:

I think this PR should include:

https://github.com/crate/crate-docs/blob/main/.readthedocs.yml

I believe this would better apply to this patch instead?

With kind regards,
Andreas.

Copy link
Contributor

@nomicode nomicode left a comment

Choose a reason for hiding this comment

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

lgtm! thanks so much!

and yes, agreed, re adding the .readthedocs.yml file to this PR before merging

- Get rid of buildout
- Use "crate-docs" build system
- Add ".readthedocs.yml"
- CI: Run link checker on PRs and each night
- Fix broken links
- Get rid of mentioning the "enterprise" version
- Add "installation" section to README.rst
- Add badges
@amotl
Copy link
Member Author

amotl commented Jun 9, 2021

Agreed, re. adding the .readthedocs.yml file to this PR before merging

I just added this file.

@amotl amotl mentioned this pull request Jun 9, 2021
@amotl amotl merged commit 7c77455 into master Jun 9, 2021
@amotl amotl deleted the amo/update-docs branch June 9, 2021 15:19
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.

upgrade docs build system
2 participants