MyST-Parser
Our great sponsors
| MyST-Parser | sphinx-vhdl | |
|---|---|---|
| 4 | 1 | |
| 685 | 19 | |
| 2.2% | - | |
| 7.0 | 0.0 | |
| 10 days ago | over 1 year ago | |
| Python | Python | |
| MIT License | 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.
MyST-Parser
- Minimum Viable Hugo – No CSS, no JavaScript, 1 static HTML page to start you off
-
Python toolkits
Sphinx along with MyST-parser to write documentation in markdown. I recently discovered portray which seems like a nice alternative as it supports markdown by default for both generic documentation and docstring in modules, class, methods and functions.
-
On Yak Shaving and, a New HTML Element for Markdown
https://github.com/executablebooks/myst-parser :
> MyST is a rich and extensible flavor of Markdown meant for technical documentation and publishing.
> MyST is a flavor of markdown that is designed for simplicity, flexibility, and extensibility. This repository serves as the reference implementation of MyST Markdown, as well as a collection of tools to support working with MyST in Python and Sphinx. It contains an extended CommonMark-compliant parser using markdown-it-py, as well as a Sphinx extension that allows you to write MyST Markdown in Sphinx.
https://markdown-it-py.readthedocs.io/en/latest/ :
> *Follows the CommonMark spec for baseline parsing;
-
A step towards educating with Spyder
This project is just the first step towards making Spyder an educational tool. In the future, we hope that we can develop the infrastructure necessary to support in-IDE tutorials, by improving the tools like Jupyter Book, sphinx-thebe, MyST-Parser which will provide better integration to write educational tutorials.
sphinx-vhdl
-
sphinx-vhdl: Automatic generation of documentation from VHDL
A student on my team created an extension for Sphinx that allows you to generate documentation directly from comments in VHDL code. Do you know sphinx-vhdl yet? This extension is available as open-source on GitHub, and you can install it from PyPi. https://github.com/CESNET/sphinx-vhdl
What are some alternatives?
Python-Markdown - A Python implementation of John Gruber’s Markdown with Extension support.
sphinx-revealjs - HTML Presentation builder for Pythonista
jupyter-book - Create beautiful, publication-quality books and documents from computational content.
edalize - An abstraction library for interfacing EDA tools
sphinxcontrib-mermaid - Mermaid diagrams in yours sphinx powered docs
VHDL-Issues
sphinx-diagrams - Rough Sphinx extension for diagrams
sphinx-readme - Generate Beautiful reStructuredText README.rst for GitHub, PyPi, GitLab, BitBucket
sphinx-thebe - A Sphinx extension to convert static code into interactive code cells with Jupyter, Thebe, and Binder.
sphinxcontrib-hdl-diagrams - Sphinx Extension which generates various types of diagrams from Verilog code.
sphinx - The Sphinx documentation generator