Read the Docs VS sphinx

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?

First things first, sign up on Read the Docs and connect your GitHub account. This allows Read the Docs to access your repositories.

ReadTheDocs - ReadTheDocs hosts documentation for many Django packages. It provides easy access to comprehensive documentation, including installation instructions, configuration guides, and usage examples.

fixes are here: https://github.com/readthedocs/readthedocs.org/issues/10290

Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.

ReadTheDocs: An open-source platform for creating and hosting documentation, with support for multiple programming languages and integration with version control systems.

Well, by now I really invite all the readers to join and read more about the datadelivery Terraform module. There is a huge documentation page hosted on readthedocs with many useful information about how this project can help users on their analytics journey in AWS.

ReadTheDocs is a free way to host your open-source documentation.

They are using this infrastructure as the moat. ReadTheDocs is also doing the same thing.

Deploy if you dare: https://github.com/readthedocs/readthedocs.org

That "/*/tree" rule means that search engine crawlers are allowed to hit the README file of a repo but effectively NONE of the other files in it.

Which means that if you keep your project documentation on GitHub in a docs/ folder it won't be indexed!

You need to publish it to a separate site via GitHub Pages, or use https://readthedocs.org/

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.