cruft
sphinx
cruft | sphinx | |
---|---|---|
6 | 31 | |
1,157 | 6,046 | |
2.6% | 1.1% | |
2.0 | 9.8 | |
9 days ago | 5 days ago | |
Python | Python | |
MIT License | 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.
cruft
-
copier VS cruft - a user suggested alternative
2 projects | 5 May 2023
- How is everyone managing project config?
-
Python toolkits
I maintain cookiecutter templates (can't share. It's in companies private repository) which have all these tool included along with some CI/CD pipelines. In case the template changes, we use cruft to update existing project which was using that template.
-
create_app: A tool that allows to quickly get your basic project structure ready, while adopting the best technologies, tools, and practices
Have a look at cruft. It also uses cookicutter but has extra features like updating existing projects with template updates over the project lifetime.
-
A language-agnostic project generator
There's this project that does that: https://github.com/cruft/cruft/
-
Architectural question: How to create a "base" code and allow separate projects to depend on it, and build their own stuff on top, while keeping the base code in sync...
https://cookiecutter.readthedocs.io/en/1.7.2/ https://github.com/cruft/cruft
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?
copier - Library and command-line utility for rendering projects templates.
MkDocs - Project documentation with Markdown.
ptb-django-cookiecutter - A simple cookiecutter to create Python Telegram bots, wrapped with Django.
pdoc - API Documentation for Python Projects
cookiecutter-django-wagtail - Cookiecutter Django + Wagtail
Pycco - Literate-style documentation generator.
cookiecutter-django - Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
black - The uncompromising Python code formatter
mkdocs-material - Documentation that simply works
goli - A sophisticated boilerplate generator based on best practices and modern useful templates
Python Cheatsheet - All-inclusive Python cheatsheet