MEG wiki

The MEG-wiki is available at the address: https://meg-wiki.hnp.fcbg.ch Contributions in all forms are welcome. Please use the issue tracker to propose changes, additions and report issues and solutions found when working with MEG data from our site.

Contribution

Pull request and structure

Pull request to the repository are welcome. The wiki is organized as a python project with a sphinx documentation. The documentation, used to generate the website HTML pages, is written in reStructuredText format in the doc folder.

In a pull request, the automatic workflows will build the documentation and check for conformity. Any warnings and errors during the build process must be resolved before the pull request can be merged.

Building the documentation locally

After cloning the repository, the project and its dependencies can be installed in a python environment with:

$ pip install -e path/to/meg-wiki[all]

Additionally, pre-commit hooks are available to check for common errors before committing changes.

$ pip install pre-commit
$ pre-commit install

The documentation can be build from the meg-wiki/doc folder with make commands:

• make html to build the entire website.
• make html-noplot to build the website without running the tutorials.
• make clean to remove the generated and build files.
• make view to open the build website in the default browser.
• make linkcheck followed by make linkcheck-grep to test for broken URLs.

Additional information

Additional information can be found on the contributing guide.