sphinx
Hugo
sphinx | Hugo | |
---|---|---|
31 | 549 | |
6,059 | 72,657 | |
1.3% | 1.0% | |
9.8 | 9.8 | |
2 days ago | 5 days ago | |
Python | Go | |
GNU General Public License v3.0 or later | Apache License 2.0 |
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.
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.
Hugo
-
Building static websites
At one point though I realized there is a scaling problem with my build minutes. I knew that golang has considerably faster builds and in my case the easy fix is swapping over to Hugo.
-
Creating excerpts in Astro
This blog is running on Hugo. It had previously been running on Jekyll. Both these SSGs ship with the ability to create excerpts from your markdown content in 1 line or thereabouts.
-
Craft Your GitHub Profile Page in 60 Seconds with Zero Code, Absolutely Free
Hugo
- Release v0.123.0 · Gohugoio/Hugo
-
Top 5 Open-Source Documentation Development Platforms of 2024
Hugo is a popular static site generator specifically designed to create websites and documentation lightning-fast. Its minimalist approach, emphasis on speed, and ease of use have made it popular among developers, technical writers, and anybody looking to construct high-quality websites without the complexity of typical CMS platforms.
-
Ask HN: Looking for lightweight personal blogging platform
As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.
-
Get People Interested in Contributing to Your Open Project
Create the technical documentation of your project You can use any of the following options: * A wiki, like the ArchWiki that uses MediaWiki * Read the Docs, used by projects like Setuptools. Check Awesome Read the Docs for more examples. * Create a website * Create a blog, like the documentation of Blowfish, a theme for Hugo.
-
Writing a SSG in Go
Doing this made me appreciate existing SSGs like Hugo and Next.js even more👏👏
- Hugo 0.122 supports LaTeX or TeX typesetting syntax directly from Markdown
-
Why Blogging Platforms Suck
I suggest hugo: https://gohugo.io/
Generates a completely static website from MD (and other formats) files; also handles themes (including a lot of them rendering well on mobile), and different types of content - posts, articles, etc. - depending on the theme.
It's open source and, being completely static, cheap as fuck to self host.
What are some alternatives?
MkDocs - Project documentation with Markdown.
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
pdoc - API Documentation for Python Projects
Pycco - Literate-style documentation generator.
Pelican - Static site generator that supports Markdown and reST syntax. Powered by Python.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
eleventy 🕚⚡️ - A simpler site generator. Transforms a directory of templates (of varying types) into HTML.
mkdocs-material - Documentation that simply works
Hexo - A fast, simple & powerful blog framework, powered by Node.js.
Python Cheatsheet - All-inclusive Python cheatsheet
obsidian-export - Rust library and CLI to export an Obsidian vault to regular Markdown