sphinx VS Nikola

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.

Nikola is a feature-rich static site generator that supports a variety of formats for content creation, including reStructuredText, Markdown, and Jupyter Notebooks. It offers a flexible architecture, allowing you to use different template engines and supports plugins for extending functionality. Nikola is suitable for both simple blogs and complex websites.

You can - you'd basically just create a python script that parses your HTML/CSS files and replaces strings with values from your YAML. However I wouldn't recommend that unless you're just using this as an opportunity to learn Python. If you want to standup a real site and you want to use python, I'd recommend a Python static site generator like Pelican or Nikola.

I tend to prefer static site generators for this kind of use case. I use Nikola, which is written in and based on Python. You should be able to pick whatever html5up template you like and turn it into a Nikola template, too.

I switched to Nikola recently: https://getnikola.com/

Reads every kind of plaintext format, but will also just publish a Jupyter notebook which means you can do drag and drop image and graph inlining which makes everything so much simpler (and thus makes me more likely to keep it up).

I've been using Nikola and am happy with it: https://github.com/getnikola/nikola

Might be this static site generator: https://getnikola.com/

Found it by searching [nikola software].

I know you say you're comfortable with your workflow, but just wanted to throw out that if you're not dependent on Jekyll, and are simply looking for the best way to create a static site/blog from org-mode files, you could consider Nikola as an alternative. It has an excellent org-mode plugin which would likely solve your complication.

I also know that there is also Python-based Lektor [2], however I found Nikola more intriguing than this one.

[0] https://getnikola.com/