DOC: Add a few components to the sphinx example (#38)

* Added testing of citations. * Added bibliography directive to .rst and .md files. * Added sample bibliography derived from QuantEcon. * Updated dependencies/conf with sphinxcontrib-bibtex * Added ipython dependency for sphinx. * Added dummy documents for testing {doc} inline token. * Added two dummy .md files as link targets * Added dummy files to hidden toctree in index.
executablebooks · Feb 15, 2020 · 8c7c7a7 · 8c7c7a7
1 parent 935222b
commit 8c7c7a7
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,7 +28,10 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["myst_parser"]
+extensions = [
+    "myst_parser",
+    "sphinxcontrib.bibtex",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/heavy_tails.md b/docs/heavy_tails.md
@@ -0,0 +1 @@
+# DUMMY DOCUMENT FOR TESTING :doc: ROLE
diff --git a/docs/index.md b/docs/index.md
@@ -44,3 +44,11 @@ caption: Example pages
 wealth_dynamics_rst.rst
 wealth_dynamics_md.md
 ```
+
+```{toctree}
+---
+hidden: True
+---
+heavy_tails.md
+kesten_processes.md
+```
diff --git a/docs/kesten_processes.md b/docs/kesten_processes.md
@@ -0,0 +1 @@
+# DUMMY DOCUMENT FOR TESTING :doc: ROLE
diff --git a/docs/references.bib b/docs/references.bib
@@ -0,0 +1,12 @@
+###
+Single example from the QuantEcon Bib
+###
+@article{benhabib2018skewed,
+    title={Skewed wealth distributions: Theory and empirics},
+    author={Benhabib, Jess and Bisin, Alberto},
+    journal={Journal of Economic Literature},
+    volume={56},
+    number={4},
+    pages={1261--91},
+    year={2018}
+}
diff --git a/docs/wealth_dynamics_md.md b/docs/wealth_dynamics_md.md
@@ -466,3 +466,6 @@ plt.show()
 
 We see that greater volatility has the effect of increasing inequality
 in this model.
+
+```{bibliography} references.bib
+```
diff --git a/docs/wealth_dynamics_rst.rst b/docs/wealth_dynamics_rst.rst
@@ -483,3 +483,5 @@ volatility term :math:`\sigma_r` in financial returns.
 
 
 We see that greater volatility has the effect of increasing inequality in this model.
+
+.. bibliography:: references.bib
diff --git a/setup.py b/setup.py
@@ -48,7 +48,13 @@
             "pytest-regressions",
             "beautifulsoup4",
         ],
-        "sphinx": ["pyyaml", "docutils>=0.15", "sphinx>=2,<3"],
+        "sphinx": [
+            "pyyaml",
+            "docutils>=0.15",
+            "sphinx>=2,<3",
+            "sphinxcontrib-bibtex",
+            "ipython",
+        ],
     },
     zip_safe=True,
 )