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

Theme: Update to crate-docs-theme==0.34.0.dev6 #79

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Conversation

amotl
Copy link
Member

@amotl amotl commented Jul 18, 2024

About

This RTD build gives you the chance to preview and review the documentation, using a pre-release of the modernized crate-docs-theme, based on sphinx-basic-ng/Furo.

Note

Also increases toctree maxdepth to 4. That may be good, or not, or it doesn't matter at all. Before, it was 2. See crate/crate-docs-theme#515.

Preview

https://crate-cloud--79.org.readthedocs.build/en/79/

Thoughts

  • It doesn't look too bad. Thanks for your fixes, @msbt!

  • If you agree, and don't object a slight anomaly in appearance, because other projects are not using the modernized theme yet, you are free to merge it at your disposal.

  • If you can spot any flaws or other more serious regressions, or just little ones, please let us know about them!

References

/cc @surister, @simonprickett, @kneth

@amotl amotl force-pushed the theme-ng branch 2 times, most recently from fca6bb1 to 530afaf Compare July 18, 2024 21:24
@amotl amotl changed the title [TEMP] Update to crate-docs-theme==0.34.0.dev1 Update to crate-docs-theme==0.34.0.dev4, for evaluation purposes Jul 31, 2024
@amotl amotl marked this pull request as ready for review July 31, 2024 11:27
Copy link
Contributor

@msbt msbt left a comment

Choose a reason for hiding this comment

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

lets go

@amotl
Copy link
Member Author

amotl commented Jul 31, 2024

lets go

^^ @proddata can decide if he wants to merge it, or not. If yes, please do on your own behalf. Thanks!

@amotl amotl force-pushed the theme-ng branch 2 times, most recently from 4476481 to 8506ae4 Compare August 1, 2024 16:09
@amotl amotl changed the title Update to crate-docs-theme==0.34.0.dev4, for evaluation purposes Update to crate-docs-theme==0.34.0.dev5, for evaluation purposes Aug 1, 2024
@amotl
Copy link
Member Author

amotl commented Aug 1, 2024

Also increases toctree maxdepth to 4. Before, it was 2.

It certainly makes a difference, for example here. You have to decide if you want it or not.

Before/After

A picture says...

image image

/cc @msbt, @matkuliak, @simonprickett, @karynzv, @hammerhead, @hlcianfagna, @proddata, @widmogrod

@amotl amotl requested a review from msbt August 1, 2024 16:43
@amotl amotl changed the title Update to crate-docs-theme==0.34.0.dev5, for evaluation purposes Theme: Update to crate-docs-theme==0.34.0.dev5 Aug 1, 2024
- Uses beta version of next generation theme.
- Increases toctree maxdepth to 4.
@amotl amotl changed the title Theme: Update to crate-docs-theme==0.34.0.dev5 Theme: Update to crate-docs-theme==0.34.0.dev6 Aug 5, 2024
@amotl
Copy link
Member Author

amotl commented Aug 5, 2024

Hi again. It looks like both <ul>/<li>/<a> woes, and flaws with tables, have been resolved now. Can you spot any other problems?

@proddata proddata merged commit c83678f into main Aug 6, 2024
3 checks passed
@proddata proddata deleted the theme-ng branch August 6, 2024 07:08
@amotl
Copy link
Member Author

amotl commented Aug 6, 2024

Thanks for merging!

@proddata
Copy link
Member

proddata commented Aug 6, 2024

Thanks for merging!

I just followed your orders :D

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.

3 participants