Merge pull request #369 from umarcor/umarcor/docs/bibtex

docs: add References through BibTeX

docs/conf.py

@@ -65,8 +65,12 @@ extensions = [
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinxcontrib_hdl_diagrams',
+    'sphinxcontrib.bibtex',
 ]
 
+bibtex_default_style = 'plain'
+bibtex_bibfiles = ['refs.bib']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/index.rst

@@ -24,7 +24,7 @@
     contributing
     partners
 
-
+    references
 
 
 Welcome to SkyWater SKY130 PDK's documentation!

docs/references.rst

@@ -0,0 +1,8 @@
+.. _References:
+
+References
+##########
+
+.. bibliography::
+  :notcited:
+  :labelprefix: R

docs/refs.bib

@@ -0,0 +1,6 @@
+@Online{SkyWaterPDKIntro_Edwards21,
+  author = {Edwards, Tim},
+  title = {{Introduction to the SkyWater PDK: The New Age of Open Source Silicon}},
+  url = {https://isn.ucsd.edu/courses/beng207/lectures/Tim_Edwards_2021_slides.pdf},
+  year = {2021},
+}

docs/requirements.txt

@@ -3,6 +3,7 @@ git+https://github.com/SymbiFlow/sphinx_symbiflow_theme.git#egg=sphinx-symbiflow
 docutils
 sphinx
 sphinx-autobuild
+sphinxcontrib-bibtex
 
 # Verilog domain
 sphinx-verilog-domain