Project

General

Profile

Use sphinx + read the doc for documentation?

Added by Skoll RC about 1 month ago

Hi everyone!

Most of popular opensource projects use shpinx + read the doc for documentation. It's clear (much more than redmine's wiki), and version/code related.
What about using this for Replicant?

The actual documentation is a mess (it exists and it's a good start). Maybe it could help to improve the visibility and usability of Replicant.

https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html


Replies (4)

RE: Use sphinx + read the doc for documentation? - Added by Kurtis Hanna about 1 month ago

We are looking to leave Redmine for a number of reasons, including limitations we have experienced with its wiki.

One idea we have is to move to MediaWiki. We talk about that here: https://redmine.replicant.us/projects/replicant-infrastructure/wiki/MediawikiMigration

RE: Use sphinx + read the doc for documentation? - Added by Skoll RC about 1 month ago

It is also hard to have clear and structured infos with mediawiki. But at least any could export data from mediawiki.

RE: Use sphinx + read the doc for documentation? - Added by Daniel Kulesz about 1 month ago

Personally, I am in favor of OP's suggestion and recommend switching to Sphinx as well. I find working on documentation and approving changes using git much more "floss-natural" than giving permission to "trusted" authors only when using a system like mediawiki. Imho, the latter puts up a significantly higher hurdle for new docs contributors.

RE: Use sphinx + read the doc for documentation? - Added by Fil Lupin 10 days ago

Hi,
I wonder if mediawiki would not be easier to use with wikidata, especially it could help include wikidata elements for hardware by using SPARQL requests.
But my hope is only based on the fact that this tool is close to the ones used by wikidata.

    (1-4/4)