evansosenko.com
sphinx
evansosenko.com | sphinx | |
---|---|---|
1 | 31 | |
3 | 6,123 | |
- | 1.5% | |
6.5 | 9.8 | |
about 1 month ago | 6 days ago | |
HTML | Python | |
- | GNU General Public License v3.0 or later |
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.
evansosenko.com
-
Minimum Viable Hugo – No CSS, no JavaScript, 1 static HTML page to start you off
Since we're sharing, here is my personal site in Hugo without using any starter templates or themes.
https://github.com/evansosenko/evansosenko.com
Going back to basics and having zero external dependencies is quite enjoyable. Understanding how Hugo templates, themes, and content all work together was more complicated than I originally expected, but they have build a good system. Hopefully this helps anyone looking to get started.
sphinx
-
5 Best Static Site Generators in Python
Sphinx is primarily known as a documentation generator, but it can also be used to create static websites. It excels in generating technical documentation, and its support for multiple output formats, including HTML and PDF, makes it a versatile tool. Sphinx uses reStructuredText for content creation and is highly extensible through plugins.
-
User Guides in Code Documentation: Empowering Users with Usage Instructions
Sphinx a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. That is, if you have a directory containing a bunch of reStructuredText or Markdown documents, Sphinx can generate a series of HTML files, a PDF file (via LaTeX), man pages and much more.
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Notable mentions to [Sphinx](https://www.sphinx-doc.org/). It's workflow is more tuned to the "book" format rather than the blog, forum or thread format.
-
best packages for documenting the flow of logic?
Currently trying out Sphinx (https://www.sphinx-doc.org) and the trying to get the autodocgen feature to see what that can do.
-
Generate PDF from file (docstrings)
So, I've documented my code and now I need a .PDF with this documentation. Is there any easy way to do it? Once I used Sphinx but it generated a not so easy .TeX.
-
Introducing AutoPyTabs: Automatically generate code examples for different Python versions in MkDocs or Sphinx based documentations
AutoPyTabs allows you to write code examples in your documentation targeting a single version of Python and then generates examples targeting higher Python versions on the fly, presenting them in tabs, using popular tabs extensions. This all comes packaged as a markdown extension, MkDocs plugin and a Sphinx, so it can easily be integrated with your documentation workflow.
-
dictf - An extended Python dict implementation that supports multiple key selection with a pretty syntax.
Honestly, I think it's just an issue of documentation. For example, if there was an easier way to document @overload functions, that would help (cf. https://github.com/sphinx-doc/sphinx/issues/7787)
-
Pipeline documentation
We use sphynx for our pipeline documentation for all technical details Classes , packages and functions docstrings using reStructuredText (reST) format
-
Minimum Viable Hugo – No CSS, no JavaScript, 1 static HTML page to start you off
I like Sphinx [0] with the MyST Markdown syntax [1]. There is a related project, Myst NB [2], which enables including Jupyter notebooks in your site. There is also a plugin for blogging [3].
[0]: https://www.sphinx-doc.org
-
Marketing for Developers
Sphinx is the go-to tool for documentation. It took me a while to understand how to use Sphinx, but I now have a decent workflow with MyST which allows me to write all the docs in markdown. My sphinx-markdown-docs repo shows an example of what I do.
What are some alternatives?
homepage - Homepage for yboris.com built with Hugo
MkDocs - Project documentation with Markdown.
minimum-viable-hugo - No CSS, no JS. One static HTML page to start you off.
pdoc - API Documentation for Python Projects
homepage-dev - Homepage for yboris.dev built with Hugo
Pycco - Literate-style documentation generator.
utilitarianism.net - Official repository for utilitarianism.net
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
mkdocs-material - Documentation that simply works
Hugo - The world’s fastest framework for building websites.
Python Cheatsheet - All-inclusive Python cheatsheet