Is jupyter book good for software project documentation? #1025
Unanswered
cosmicBboy
asked this question in
Q&A
Replies: 1 comment
-
JupyterBook is based on top of the Sphinx project, which is used quite extensively for documentation -- especially in the Python ecosystem. The different pieces of JupyterBook can also be used independently directly with Sphinx (e.g. the book-theme). I would say that if your project is in Python, then JupyterBook/Sphinx will be great for the project! If it is based in another language, some of the integrations might not be as easy out of the box, but it would still work well. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I know it's called "jupyter book", but are there any examples of software libraries/project that use it for their documentation site? Just curious if there are any fundamental things about it that would make that a bad idea.
Beta Was this translation helpful? Give feedback.
All reactions