MagicSetEditor2 icon indicating copy to clipboard operation
MagicSetEditor2 copied to clipboard

Host current docs

Open fenhl opened this issue 5 years ago • 6 comments

The MSE docs currently hosted at http://magicseteditor.sourceforge.net/doc are outdated. Would it make sense to keep them updated with new releases? If not, the new docs should be hosted somewhere else, but where? Having an instance of the docs for the current master branch would also be nice.

fenhl avatar Aug 28 '20 08:08 fenhl

I can offer to host the docs on a subdomain of lore-seeker.cards, but I'm not familiar with Drupal so I might need some assistance with setting things up, and obviously the domain name would be kind of unrelated.

fenhl avatar Aug 28 '20 08:08 fenhl

I was thinking about converting the documentation to markdown or rst and hosting it on readthedocs.org. That way the docs will stay up to date with what is in git. The only issue is that this wouldn't support syntax highlighting of MSE script code, but that is not a very big deal.

twanvl avatar Aug 29 '20 12:08 twanvl

In that case, I'd say Markdown is the better choice as it's a better-known language.

fenhl avatar Aug 29 '20 12:08 fenhl

I am working on converting the docs to Markdown at https://github.com/fenhl/MagicSetEditor2/tree/markdown-docs.

fenhl avatar Sep 29 '20 12:09 fenhl

FYI, there is a parser for the current doc format in tools/website/drupal/mse-drupal-modules/autoformat.inc (written in php). It should work stand alone without drupal. You could probably modify this to spit out markdown or rst. Not sure if that is worth the effort though.

I would still prefer to go with sphynx-doc and restructured text, it seems much more featurefull than markdown. In particular with regards to internal links. But if there is a nice markdown based tool supported by readthedocs.org that would also work for me.

twanvl avatar Sep 29 '20 12:09 twanvl

I've converted the first few pages to Markdown and building them with Sphinx works (you can try it with .\doc\make.bat html).

fenhl avatar Sep 29 '20 14:09 fenhl