Create application docs with moin, publish by loading to readthedocs

[RogerHaase]

A possible approach:

• create application docs using any of moin's markup languages
• use dump-html cli to convert to html files
• use https://stackoverflow.com/questions/64518816/readthedocs-publishing-pre-built-html-pages-to-readthedocs to load to readthedocs

[ThomasWaldmann]

If the goal is publishing docs to readthedocs, using sphinx might be the simpler and well-established approach.

[renato67]

yes (and no :-) ). I would undestand if this could be a correct tool-chain to create documentation:

• Moinmoin2 (to collect doc from various people)
• export it to Sphinx
• import on ReadtheDoc
• export in HTML or PDF

but for what I've unserstand I can export from moinmoin and import it directly to Readthedocs. avoiding Sphinx. Is it?

Renato

[sfermigier]

If the goal is publishing docs to readthedocs, using sphinx might be the simpler and well-established approach.

Editing files with an editor in a git repo and editing wikipages in a browser are two different workflows, and depending on who your users are, will feel comfortable to them or not.

[renato67]

ok,
so Moin2 has the task of collecting the doc that various people do (with his powerful to handle users)
and Readthedoc can transform this documentation to various format.
Is it so?

[renato67]

I would like to know if this is the way the 2 SW collaborate or am I wrong

[sfermigier]

I would like to know if this is the way the 2 SW collaborate or am I wrong

This is A way the two CAN (or COULD) collaborate. Obviously one can be used without the other one.

[renato67]

of course...but coul be that the scenario? (moin2 collect doc and RTD publish it in various format)?

[ReimarBauer]

The effort to keep the docs uptodate increases by version and time.
I do prefer a git repository just for comparing between two releases.

When building the docs on rtfd you can use there parts of moin to convert to rst and extend the formats for writings in the sphinx framework.

[renato67]

still not clear...
Do RTD and Sphinx make the same work? If yes, I can realize the entire doc (made by various author) with a wiki (moin2 or something else) then paste it to RTD and obtain various format.
Isn't it?

[ReimarBauer]

When you make the installation and develop doc and usage doc with the wiki, why do you want to use RTD?

Usually I ask developers on a PR to update also the docs in the repo. Writing docs is usually part of the development process. When you move the whole doc maintaining process to the wiki, then it is usually not the developer who changes it.

[renato67]

@ReimanBauer. So you are telling that I can build docs using a repo (i.e GIT) and directly RTD, without a wiki. But i.e. if I would start a chain where everybody (developer and normal employ) could write doc not just for program documentation, I could manage the "fishing" of docs by a wiki and paste the result to RTD that can produce more kind of docs.
Right?