The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning. Learn more →
Top 23 Python Sphinx Projects
-
-
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
-
-
-
-
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
-
-
lazydocs
📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
-
sphinx-immaterial
Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
-
sphinxcontrib-hdl-diagrams
Sphinx Extension which generates various types of diagrams from Verilog code.
-
-
-
sphinx-thebe
A Sphinx extension to convert static code into interactive code cells with Jupyter, Thebe, and Binder.
-
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
I went to https://readthedocs.org/ and redirected me to https://about.readthedocs.com/?ref=readthedocs.org which looks proprietary now, with pricing and such.
Is it the end of this project, as we know it?
Can someone enlighten me please?
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.
Project mention: Does anyone have working ESPHome code for a M5Stick display on Home Assistant? What am I doing wrong here? | /r/M5Stack | 2023-12-05I'm trying to use /u/jesserockz post here, but it looks like there was an ESPHome update (or something, the hell do I know) that broke that code.
Project mention: Show HN: Atopile – Design circuit boards with code | news.ycombinator.com | 2024-02-05
I haven't been able to access https://docs.syncthing.net or https://forum.syncthing.net/ but I was able to access some of the docs via github. I think I've set it up according to the docs. The logs contain lots of messages like:
Project mention: Everything that uses configuration files should report where they're located | news.ycombinator.com | 2023-06-25
If you mean which services I went to, I pulled the plug on proprietary or at least non-open-source services and walled gardens. I'm now using GitLab Pages to host both my blog and the notes I had there. I use Sphinx to manage structure and templating.
I have created a /notes folder which gets made available under the same domain ( https://jdsalaro.com/blog/category/notes/ ) which will contain all stuff I had in Evernote.
The content of my Evernote account is exported via the API and each note put into a note.md file with the first line as title, tags ( private, note) and "inferred" headings.
Within that folder there's a /private one which never gets built ( using tox ) nor published to the public version of my blog. There's a separate GitLab pipeline which only builds /private and makes it available under Gitlab pages but uses another non-public project, so you need to be logged in and a member of the repo to be able to see it.
The good thing is that I can read them everywhere and if necessary edit stuff via mobile ( Browser tab added to home screen or La coat )
Since everything is backed up using git, both the public and private versions, I don't have to worry about losing data.
Cool side-effects are that I've started using and understanding Sphinx to manage the structure and templating and even started poking around helping with the project ( https://github.com/executablebooks/sphinx-external-toc/issue... )
Really, we had the power all along but became complacent. We've got to be the change we want to see.
I fully agree with the author's "I want to replace PDF" sentiment.
It's true that running code in the document has some downsides, but the vast majority of people does it all the time in their browsers. And it comes with tremendous upsides. Just imagine large amount of data presented in interactive tables which can sort, filter and export or interactive graphs inside the document. We already use HTML+JS so much, why should we stop at documents? Yes, they can't be printed, but in my observation less and less people even own a printer these days, and I see no reason why this trend should not continue. I bet the future will be mostly living, interactive documents.
It's funny that I just mentioned this in the other thread [1], but I also felt that there is a need for a format that is self-contained and widely supported by standard software (by which I mean browsers). A well-specified open format would be great, but until then I tackled the self-containedness problem with JS and wrote a Python script that zips and bundles all assets and embeds them as a SPA into one HTML file [2]. The focus is on Sphinx docs but it should work in general with all distributed HTML docs.
[1] https://news.ycombinator.com/item?id=39138444
[2] https://github.com/AdrianVollmer/Zundler
NOTE:
The open source projects on this list are ordered by number of github stars.
The number of mentions indicates repo mentiontions in the last 12 Months or
since we started tracking (Dec 2020).
Python Sphinx related posts
- Portable EPUBs
- AMD Proposes an FPGA Subsystem User-Space Interface for Linux
- Does anyone have working ESPHome code for a M5Stick display on Home Assistant? What am I doing wrong here?
- Need help to build a RISC-V Processor on Artix-7 FPGA: Final Year Engineering Project Guide
- Running Linux on Xilinx / AMD FPGA Softcore Example Design
- best packages for documenting the flow of logic?
- Newbie's complaints about Xilinx software
-
A note from our sponsor - WorkOS
workos.com | 27 Apr 2024
Index
What are some of the best open-source Sphinx projects in Python? This list will help you:
| Project | Stars | |
|---|---|---|
| 1 | Read the Docs | 7,872 |
| 2 | sphinx | 6,032 |
| 3 | curriculum | 1,616 |
| 4 | best-of-python-dev | 910 |
| 5 | breathe | 729 |
| 6 | MyST-Parser | 685 |
| 7 | esphome-docs | 322 |
| 8 | f4pga | 314 |
| 9 | docs | 224 |
| 10 | lazydocs | 178 |
| 11 | sphinx-immaterial | 163 |
| 12 | sphinx-revealjs | 103 |
| 13 | sphinx.nvim | 70 |
| 14 | TF-Watcher | 60 |
| 15 | click-extra | 52 |
| 16 | sphinx-codeautolink | 51 |
| 17 | sphinxcontrib-hdl-diagrams | 49 |
| 18 | sphinx-external-toc | 31 |
| 19 | spyder-docs | 30 |
| 20 | sphinx-thebe | 28 |
| 21 | sphinx-vhdl | 19 |
| 22 | sphinx-diagrams | 18 |
| 23 | Zundler | 18 |
Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com