DOC: move IPython include file to the top-level docs directory

jeffgortmaker · Apr 25, 2018 · 3089daf · 3089daf
1 parent a70791f
commit 3089daf
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 3 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -8,7 +8,7 @@ The majority of the package consists of classes, which compartmentalize differen
 
 Many of the pages that the below summaries link to contain example code. For the sake of brevity, the following lines of code, which import the package, import :mod:`numpy`, and limit verbosity, are executed before each example.
 
-.. literalinclude:: static/header.py
+.. literalinclude:: include.py
   :language: ipython
 
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -47,7 +47,7 @@
 autosummary_generate = True
 ipython_savefig_dir = 'images'
 numpydoc_show_class_members = False
-ipython_execlines = Path(source_path / 'static' / 'header.py').read_text().splitlines()
+ipython_execlines = Path(source_path / 'include.py').read_text().splitlines()
 
 # add a line to be executed by IPython that stores the location of the source directory so that files can be saved
 ipython_execlines.append(f'source_path = \'{source_path.as_posix()}\'')

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -8,7 +8,7 @@ This section explains how pyblp can be used to solve standard BLP example proble
 
 To start, we'll import the package, as well as :mod:`numpy`, since we'll be using it to manipulate data. The following lines of code, which are executed before each section of examle code in the documentation, import both packages and limit verbosity. Status updates can be informative, so you'll probably want to keep your own verbosity turned on.
 
-.. literalinclude:: static/header.py
+.. literalinclude:: include.py
   :language: ipython
 
 In this section, we'll also import :mod:`matplotlib.pyplot`, which, although not a pyblp dependency, can be used to plot results.

diff --git a/docs/static/header.py → docs/include.py b/docs/static/header.py → docs/include.py