jupyter-book
Asciidoctor
jupyter-book | Asciidoctor | |
---|---|---|
15 | 35 | |
3,692 | 4,647 | |
0.8% | 0.7% | |
8.5 | 8.7 | |
6 days ago | about 1 month ago | |
Python | Ruby | |
BSD 3-clause "New" or "Revised" License | MIT 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.
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?
Asciidoctor
-
AsciidocFX: The Asciidoc Editor for documentation and authoring
AsciidocFX, is an open-source, cross-platform editor that provides an exceptional user experience and a comprehensive set of features for working with Asciidoc files. Though Asciidoctor provides these capabilities, not everyone will be comfortable enough to work in the commandline or shell setting that's where AsciidocFX comes to the rescue. Let's explore some of the key capabilities that make AsciidocFX stand out.
-
I don't always use LaTeX, but when I do, I compile to HTML (2013)
You have also AsciiDoctor ( https://asciidoctor.org/ ) which is alive and well. I am using it for technical CS documentation internally, but only for single page documents. I did not try to deploy their whole multi-document setup called Antora ( https://antora.org/ ).
-
[DEV][App Release] Markor 2.11 adds AsciiDoc and CSV Support
AsciiDoc File support. ( #1876, #808, #2022)
-
Good software/SaaS for Technical Documentation CMS
If Maths is important to you, take a look at Asciidoc - https://asciidoctor.org/
-
Documentation generators and custom syntax highlighting
I use Asciidoctor, highlightjs, a custom highlight.js language definition and that bash script:
-
I wish Asciidoc was more popular
AsciiDoc is so close to being good. It slam dunks Markdown, but they just have a few nagging issues that they refuse to fix, for 9 years now:
https://github.com/asciidoctor/asciidoctor/issues/1087
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Asciidoctor is a Ruby-based text processor for parsing AsciiDoc into a document model and converting it to HTML5, PDF, EPUB3, and other formats. Built-in converters for HTML5, DocBook5, and man pages are available in Asciidoctor. Asciidoctor has an out-of-the-box default stylesheet and built-in integrations for MathJax (display beautiful math in your browser), highlight.js, Rouge, and Pygments (syntax highlighting), as well as Font Awesome (for icons). Although Asciidoctor is written in Ruby, that does not mean you need to know Ruby to use it. Asciidoctor can be executed on a JVM using AsciidoctorJ or in any JavaScript environment (including the browser) using Asciidoctor.js. You can choose any one of three Asciidoctor processors (Ruby, JavaScript, Java/JVM) and get the same experience. You can also use the Asciidoctor Maven Plugin to convert your Asciidoc documentation using Asciidoctor from an Apache Maven build.
-
Designing Go Libraries: The Talk: The Article
asciidoctor for writing
-
Docs as code vs a tool that can work with .md and xml?
If you're looking at AsciiDoc, you'll want to look at Asciidoctor: https://asciidoctor.org/
- Diving deeper into custom PDF and ePub generation
What are some alternatives?
Spyder - Official repository for Spyder - The Scientific Python Development Environment
RDoc - RDoc produces HTML and online documentation for Ruby projects.
sphinx-thebe - A Sphinx extension to convert static code into interactive code cells with Jupyter, Thebe, and Binder.
Zettlr - Your One-Stop Publication Workbench
MyST-Parser - An extended commonmark compliant parser, with bridges to docutils/sphinx
plantuml - Generate diagrams from textual description
quarto-cli - Open-source scientific and technical publishing system built on Pandoc.
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
heron
hugo-PaperMod - A fast, clean, responsive Hugo theme.