sphinx VS plantuml

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.

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.

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.

Currently trying out Sphinx (https://www.sphinx-doc.org) and the trying to get the autodocgen feature to see what that can do.

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.

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.

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)

We use sphynx for our pipeline documentation for all technical details Classes , packages and functions docstrings using reStructuredText (reST) format

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

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.

New version 3.0 of my PlantUML App for iPad is out with exciting update! 🤩 The new multi-modality feature now lets you transform hand-drawn diagrams into PlantUML scripts with just a pencil ✍🏻 or your fingers 👆. Take a look 👀 to this short on YouTube and download it from App Store to support me 👍🏻.

Someone at work showed me https://plantuml.com/ recently. If you want your diagrams as code . Version controlled etc.. I highly recommend it.

Maybe try PlantUML.

Open-source tool that uses simple textual descriptions to draw beautiful UML diagrams.

Seems like a considerable upgrade from PlanUML (https://plantuml.com/ - which is amazing, but sometimes you just can't seem to be able to align the stuff the way you want too).

plantuml is amongst the best there is. kroki.io has a sandbox for it mermaid.js can do it in notion, it works as well as any other mermaid. dbvisualizer is fantastic if you have an existing schema in a db instance. you may need the trial license to render the diagrams

PlantUML ima podsku za mnogo vise dijagrama - https://plantuml.com/ (bar za sada).

I mean, I know about PlantUML where you can write code that will generate cool diagrams and it's feels like one of solutions\implementations but not the right one. What actual way people in huge companies create UML diagrams for their projects? I can't find any software or language syntax, even guides on Youtube about UML is just hours of talking about all sorts of UML diagrams without ever mentioning any software or syntax or actual way to create them.