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

Move to mkdocs #8

Open
mdbenito opened this issue Feb 10, 2023 · 4 comments
Open

Move to mkdocs #8

mdbenito opened this issue Feb 10, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mdbenito
Copy link
Member

Sphinx is a constant source of indescribable pain and frustration. Countless hours wasted staring at bogus error messages because of a missed white space somewhere or something even more idiotic. Almost infinite build times consuming the forests of the Earth.

If mkdocs supports bibtex and latex-style dollar inline math, let's switch and never look back

@mdbenito mdbenito added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 10, 2023
@MischaPanch
Copy link
Collaborator

Moved to jupyter-book (which is kinda still sphinx). Should work nicely for now

@mdbenito
Copy link
Member Author

Moved to jupyter-book (which is kinda still sphinx). Should work nicely for now

The issue with sphinx is not how it renders, but its appalling error reporting, which paired with a terribly finicky parser make for infinite debug loops and enormous time wasted. I don't think Jupyter book addresses any of these problems.

@mdbenito mdbenito reopened this Feb 27, 2024
@MischaPanch
Copy link
Collaborator

Let's see for how long the current setup will work without me having to touch it in tianshou and other projects created by this template.

I am agnostic about which tool to use, but I won't have time in the foreseeable future to make the move to mkdocs.

For anyone interested in this issue: an mkdocs based setup should reproduce the nice rendering, caching and execution of notebooks that jupyter book currently provides

@mdbenito
Copy link
Member Author

For reference / inspiration: pyDVL uses mkdocs, mkdocs-material as template and mike for versioning.

@mdbenito mdbenito changed the title Ditch sphinx for mkdocs Move to mkdocs Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants