https://github.com/altaris/refgraph
Reference graph for LaTeX projects
https://github.com/altaris/refgraph
Last synced: 3 months ago
JSON representation
Reference graph for LaTeX projects
- Host: GitHub
- URL: https://github.com/altaris/refgraph
- Owner: altaris
- License: mit
- Created: 2022-01-04T08:46:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-25T05:42:27.000Z (over 3 years ago)
- Last Synced: 2025-01-07T22:39:05.061Z (5 months ago)
- Language: Python
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# refgraph
[](https://pypi.org/project/black)
Reference graph for LaTeX projects
## Using the Github action
```yml
- 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
```sh
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
```sh
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
```sh
make docs-browser
```
### Code quality
Don't forget to run
```sh
make
```
to format the code following [black](https://pypi.org/project/black/),
typecheck it using [mypy](http://mypy-lang.org/), and check it against coding
standards using [pylint](https://pylint.org/).