sphinx
Lektor
sphinx | Lektor | |
---|---|---|
31 | 20 | |
6,046 | 3,769 | |
0.8% | 0.2% | |
9.8 | 7.7 | |
1 day ago | 2 months ago | |
Python | Python | |
GNU General Public License v3.0 or later | 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.
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.
Lektor
-
Tech Debt: My Rust Library Is Now a CDO
Guess I'm one of the annoying users who complained when armin's Lektor (https://github.com/lektor/lektor) started going dormant back when, but I loved it for a while. I'm on Astro now, but a big thanks for helping a younger version for me.
- Show HN: Pages CMS – A CMS for GitHub
- Ask HN: Looking for lightweight personal blogging platform
-
5 Best Static Site Generators in Python
Lektor is a modern and flexible static content management system that utilizes Python as its core language. It comes with an intuitive web-based admin interface, making it easy for content creators to manage and update the site. Lektor supports a variety of content types and has an active community that contributes to its continuous improvement.
-
The theory versus the practice of “static websites”
Lektor CMS is sort of a prototype-ish thing doing this: https://www.getlektor.com/
It has (used to have? Can't find them on the site now) pre-packaged binaries that you would drop into a folder structure generated by the technically-minded person, and the content editor can simply click on that binary, which opens the backend of the CMS in the web browser, make changes and click deploy.
-
Flask CMS - Wordpress alike
There have been several Flask-based CMS's but I don't remember most of them. IIRC Lektor is based on Flask.
- Why isn’t there a python version of Jekyll / Hugo
-
A SvelteKit template for building CMS-free editable websites
Static hosting could be enough for many sites and one could combine the technical and UX advantages of your dynamic interface with the advantages of static sites for security and distribution.
I found that useful when i worked with https://www.getlektor.com/ years ago. In lektor the dynamic part runs on a users desktop machine, but it of course wouldn't need to.
-
Minimum Viable Hugo – No CSS, no JavaScript, 1 static HTML page to start you off
Lektor is Python based and Just Works, but it is far off the beaten track… https://www.getlektor.com/
- Static Site Generator Request
What are some alternatives?
MkDocs - Project documentation with Markdown.
Pelican - Static site generator that supports Markdown and reST syntax. Powered by Python.
pdoc - API Documentation for Python Projects
Nikola - A static website and blog generator
Pycco - Literate-style documentation generator.
Hugo - The world’s fastest framework for building websites.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
Jekyll - :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
mkdocs-material - Documentation that simply works
Hyde - A Python Static Website Generator
Python Cheatsheet - All-inclusive Python cheatsheet
Cactus - Static site generator for designers. Uses Python and Django templates.