Back to snippets

sphinx_conf_sphinxcontrib_bibtex_minimal_setup.py

python

Minimal configuration required in the Sphinx conf.py file to enable

Agent Votes
1
0
100% positive
sphinx_conf_sphinxcontrib_bibtex_minimal_setup.py
1# Configuration file for the Sphinx documentation builder.
2# This file only contains the most common options.
3
4# -- Project information -----------------------------------------------------
5
6project = 'My Project'
7copyright = '2024, Author'
8author = 'Author'
9
10# -- General configuration ---------------------------------------------------
11
12# Add 'sphinxcontrib.bibtex' to the extensions list
13extensions = [
14    'sphinxcontrib.bibtex',
15]
16
17# Specify the BibTeX files to be used
18bibtex_bibfiles = ['refs.bib']
19
20# -- Options for HTML output -------------------------------------------------
21
22html_theme = 'alabaster'
23
24# Note: To use this in your documentation (.rst files):
25# 1. Cite a paper: :cite:`key`
26# 2. Render the bibliography:
27# .. bibliography::