Kenneth Hoste writes: > We certainly welcome contributions to the documentation! > > It's housed in the 'docs' subdirectory of the 'easybuild' repository at > https://github.com/easybuilders/easybuild. > > Updated to the docs can be made via pull requests, see > https://github.com/easybuilders/easybuild/pull/616 for example.
Yep! I was able to do that last night (PR #617 is out there). > We use the reStructuredText format for the documentation. Yet another formatting system :-) MD, RST, YAML, HTML, Wiki, Confluence, and none of them play well with the others :-/ > A handy tool to pre-check whether the formatting works correctly is > http://rst.ninjs.org, where you can copy-paste snippets of documentation > in the box on the left, and it'll be instantly rendered on the right > (use the "Nature" theme). > > The only thing that doesn't work there is references to other parts of > the documentation, so you'll need to double/triple check those manually. I was trying to us rst2html, and it couldn't handle _any_ of the :ref: tags, not even to links within the page. I noticed that all of the section headings had auto-generated IDs based on their text, but I didn't want to try to use that directly without being able to validate it. > Or, you can set up readthedocs for your fork of the easybuild repo, if > you're up for that, to thoroughly pre-check the formatted docs before > opening the pull request (see for example > https://github.com/easybuilders/easybuild/pull/607). Interesting! -- Mike
