Rmagine

July 14, 2025 · View on GitHub

These docs are built with MkDocs and published to uos.github.io/rmagine_docs

Build locally

sudo apt install python3-pip
pip3 install "mkdocs>=1.6" mkdocs-material

Note: you may need to adapt your path export PATH=$PATH:/home/<USER>/.local/bin to access mkdocs binary

Using Anaconda

After downloading go into the folder of this repository.

conda env create -f environment.yml

Will create an conda environment named "rmagine_docs". Enable it by calling

conda activate rmagine_docs

Build Static Files

mkdocs build --strict

Live reloading server on :8000

mkdocs serve --strict

Deploy to uos.github.io/rmagine_docs

Anything pushed to branch deploy will trigger a Github Action that builds the website and updates uos.github.io/rmagine_docs

Contributions

You are welcome to contribute to the docs of Rmagine! Thorough and clear documentation is essential. You can help us by correcting mistakes, improving content, or adding examples that facilitate user navigation and usage of the project. Please submit any documentation-related issues here. If you're making fixes or adding examples, don’t hesitate to submit a pull request afterward!

PR workflow

How to contribute to this documentation via pull requests:

  1. Fork this repository.
  2. Make changes on your forked repository.
  3. Check locally on your machine if mkdocs is able to compile your changes (instructions).
  4. Go to Github and click "Pull Request", select this repository's "main" branch as target.
  5. If you added new content, please provide a brief explanation of why you believe it is beneficial for the documentation.
  6. Send PR.