altaris / refgraph

Reference graph for LaTeX projects

refgraph

Reference graph for LaTeX projects

Using the Github action

- uses: altaris/refgraph@v1
  with:
    directory: src
    # This will glob src/**/*.tex
- uses: actions/upload-artifact@v2
  with:
    name: pdf
    path: graph.gv.pdf

Contributing

Dependencies

• python3.8 or newer;
• requirements.txt for runtime dependencies;
• requirements.dev.txt for development dependencies.
• make (optional);

Simply run

virtualenv venv -p python3.8
. ./venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
pip install -r requirements.dev.txt

Documentation

Simply run

make docs

This will generate the HTML doc of the project, and the index file should be at docs/index.html. To have it directly in your browser, run

make docs-browser

Code quality

Don't forget to run

make

to format the code following black, typecheck it using mypy, and check it against coding standards using pylint.