Commits

Jason R. Coombs committed 5267b92 Merge

For the sake of expedience, I'm going to accept this and tweak it further. In the future, it's better to have a ticket and reference that ticket in the pull request and commits for better visibility to the changes and issues that it creates. I also suggest providing better commit messages. "Fix docs to work" is barely better than "changed things". The commit message should attempt to communicate the why and the how of the change at a high level. Something like "Added path in sphinx docs to allow setup.py to be imported when docs are built from docs directory."

  • Participants
  • Parent commits 4288246, 5648d3d

Comments (0)

Files changed (2)

File docs/conf.py

 # autogenerated file.
 #
 # All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import setup as setup_script
+# serve to show the default
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
+
+# Allow Sphinx to find the setup command that is imported below, as referenced above.
+import sys, os
+sys.path.append(os.path.abspath('..'))
+
+import setup as setup_script
 
 # -- General configuration -----------------------------------------------------
 

File setuptools.egg-info/entry_points.txt

File contents unchanged.