Some tools to format references in documentation
Project description
docite
Some tools to format references in documentation
This is a small package I created to help me format references in my documentation. It uses pandoc to convert the references from bibtex to a format that can be used in markdown files.
Installation
You can install the package via pip:
pip install docite
Usage
You can use the package from the command line as follows:
docite --input <input_file> --output <output_file> --bib <bib_file>
or:
python -m docite.cli --input <input_file> --output <output_file> --bib <bib_file>
You can also use the package from python as follows:
from docite import convert convert.convert_with_refs(input_file, output_file, bib_file)
My personal workflow is:
I use Zotero to manage my references and then export them to a Better Bibtex file.
I use the Citation Picker for Zotero extension within VSCode to add the references to my markdown files.
I use docite to generate an output markdown file with the references formatted.
Here is a gif showing how I use the package:
Making Changes & Contributing
This project uses pre-commit, please make sure to install it before making any changes:
pip install pre-commit cd docite pre-commit install
It is a good idea to update the hooks to the latest version:
pre-commit autoupdate
Don’t forget to tell your contributors to also install and use pre-commit.
Note
This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.