Any good alternatives for Sphinx to provide software documentation?

Question

I was wondering if there are any good alternatives to Sphinx when I want to provide static html documentation for software projects. Sphinx seems fine, but is mostly used in the Python field. I'm interested in a solution that could potentially be used in all non-Python projects.

My goal is to document things in markdowns or something like that, and then generate a static html site that will be delivered to users (administrators)

I also saw Gollum, but this is due to GitHub :(

Answer 1

Do you think the big problem is that Sphinx is mainly used in the Python field? It is true that Sphinx is written in Python and is primarily focused on Python documentation. But IMHO, one of the strengths, is that it can be used to document everything.

Sphinx will allow you to do exactly what you are asking for: "document material in markdowns or something like that, and then create a static html site." Sphinx uses restructuredtext , which is "or something like this" bit ".

If you want to try something a little different, I would suggest a docbook .

Answer 2

You might want to consider taking a look at Gollum . I will tell about my thoughts about Gollum, as my needs sound the same as your requirements. I recently started using Gollum for Rails project documentation, and my experience is still very positive. It was developed by people on Github, but is not tied to the Github service and can be used independently of Github.

This is a very active open source project with many committers. The foundation is Sinatra, and you can easily run it on your personal workstation. I keep the Gollum server on my development machine and directly edit the Markdown files and then view the results on the local Gollum server. This is especially nice if you configure your editor to automatically add updates by pressing a key. When you're ready, you can create a static html site using your Gollum wiki using this project.

Also, since it uses git backstage, there is built-in version control and all the power of git.