RAIDOC

Notebook-based markdown-powered documentation pages for RAIMAD.

This repository contains the source code for RAIDOC. If you just want to read the docs, please visit https://tifuun.github.io/raidoc/.

Building

First, you need to go and install graphviz. You can check that it works by running the dot command:

$ dot --version
dot - graphviz version 10.0.1 (0)

After you have dot working, install RAIDOC like any other Python package by cloning this repository:

git clone https://github.com/maybeetree/raidoc.git
cd raidoc
python -m pip install -e .

Next, you need to download Font Awesome icons and place them under doc/fontawesome

# From the root of the repo
cd doc
wget https://use.fontawesome.com/releases/v6.6.0/fontawesome-free-6.
6.0-web.zip
unzip fontawesome-free-6.6.0-web.zip
mv fontawesome-free-6.6.0-web.zip fontawesome

You can then build the documentation like this. The command MUST be run from the root of the repo.

python -m raidoc build

The output is written to the build directory. Currently, there is no incremental compilation; the above command rebuilds EVERYTHING.

TODO

• Lint references
• incremental compilation
• references to specific labels or headings
• Frontmatter parsing
  • "next" link through frontmatter
  • "previous" link automatic

License

Copyright 2024 maybetree

Documentation

The documentation files in this repository (i.e. files ending with .md under the doc/pages directory) are licensed under the GNU Free Documentation License (FDL).

Code

The code files in this repository, including all Python code, CSS and HTML templates, are licensed under the GNU General Public License (GPL).

Code snippets

The code snippets presented in the documentation pages are licensed under the CC0 License, allowing you to freely use them in your own projects.