Obidog
jupyter-book
Obidog | jupyter-book | |
---|---|---|
1 | 15 | |
4 | 3,694 | |
- | 0.9% | |
4.3 | 8.5 | |
9 months ago | 7 days ago | |
Python | Python | |
- | BSD 3-clause "New" or "Revised" License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Obidog
-
How do you document your C++ code?
To export XML which I then parse with a custom Python tool (https://github.com/ObEngine/Obidog) which will then do two things :
jupyter-book
-
I don't always use LaTeX, but when I do, I compile to HTML (2013)
Sphinx supports ReStructuredText and Markdown.
MyST-Markdown supports MathJaX and Sphinx roles and directives. https://myst-parser.readthedocs.io/en/latest/
jupyter-book supports ReStructuredText, Jupyter Notebooks, and MyST-Markdown documents:
You can build Sphinx and Jupyter-Book projects with the ReadTheDocs container, which already has LaTeX installed: https://github.com/executablebooks/jupyter-book/issues/991
myst-templates/plain_latex_book:
-
Ask HN: Fastest way to turn a Jupyter notebook into a website these days?
your task is very very broad
you mention you don't want to deal with AWS, if it's because of ad-hoc installation concerns and nothing else you can just run your notebooks in ready-made solutions like Google Colab, or Jupyter-book in Github ( https://github.com/executablebooks/jupyter-book ))
that would cover a lot of use cases right away without next to no learning curve
If you don't want to deal with AWS or similar, in that case:
- if it's a static notebook then you can obviously render it and serve the web content (might seem obvious but needs to be considered)
- if it's dynamic but has light hardware requirements, you can try jupyterlite which runs in the browser and should do a pyodine (webassembly CPython kernel) can do: https://jupyterlite.readthedocs.io/en/latest/try/lab/
- otherwise, you can try exposing a dockerised jupyter env ( as in https://github.com/MKAbuMattar/dockerized-jupyter-notebook/b... ) or even better a nixified one ( https://github.com/tweag/jupyenv )
there might be other approaches I'm missing, but I think that's pretty much it that doesn't entail some proprietary solution or an ad-hoc installation as you've been doing
-
How to raise the quality of scientific Jupyter notebooks
Note: If you want to present a cleaner version of the notebook without assertions, you can use Jupyter book to render it into a site and use the remove-cell tag to omit assertions from the output.
-
Sunday Daily Thread: What's everyone working on this week?
See this thread for example.
-
Are there any frameworks/methodologies/libraries that can help to create a PDF printable professionally looking written report?
And maybe take a look at executablebooks/jupyter-book.
- [P] I Made An Easy-To-Use Python Package That Creates Beautiful Html Reports From Jupyter Notebooks
- RStudio Is Becoming Posit
-
Python toolkits
Our team has transferred from Sphinx for documentation to JupyterBook. There have been some growing pains with it but I prefer the look of the output and being able to play with the examples on Colab or Binder at the click of a button is a great feature.
- Ask HN: Tools to generate coverage of user documentation for code
- Why does [::-1] reverse a list?
What are some alternatives?
drf-spectacular - Sane and flexible OpenAPI 3 schema generation for Django REST framework.
Spyder - Official repository for Spyder - The Scientific Python Development Environment
drf-yasg - Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.
sphinx-thebe - A Sphinx extension to convert static code into interactive code cells with Jupyter, Thebe, and Binder.
hyde - A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation
MyST-Parser - An extended commonmark compliant parser, with bridges to docutils/sphinx
pdoc - :snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
quarto-cli - Open-source scientific and technical publishing system built on Pandoc.
breathe - ReStructuredText and Sphinx bridge to Doxygen
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
heron
talk - Issues and discussions for the notes app, Nota.