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

Furo theme and MKDocs #46

Open
AndreaMonzini opened this issue Mar 28, 2024 · 0 comments
Open

Furo theme and MKDocs #46

AndreaMonzini opened this issue Mar 28, 2024 · 0 comments

Comments

@AndreaMonzini
Copy link

AndreaMonzini commented Mar 28, 2024

Blender Manual now use now a new "furo" Sphinx theme:
https://docs.blender.org/manual/en/latest/

"Furo" Sphinx theme:
https://github.com/pradyunsg/furo

Blender Developer Docs now use MKdocs
https://developer.blender.org/docs/handbook/building_blender/

as explained in the Blender Developer Blog here:
https://code.blender.org/2023/12/a-new-developer-documentation-platform/

  • So could be used the "Furo" Sphinx theme for UPGE docs ?
  • As alternative could be considered to use the MKDocs for UPGE docs ?

I personally prefer Markdown based docs like mdBook ( Rust ) or MKdocs ( Python )
But for consistence with Blender probably better to stick with Sphinx reStructuredTex.

thank you

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

1 participant