Skip to content

Commit

Permalink
add some comments to the doc conf.py just to clarify some changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ssteinbach committed May 22, 2020
1 parent a767bc8 commit 264eae6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
# this plugin is used to format our markdown correctly
'recommonmark',
# uncomment the next line if you are writing in Google Napoleon docstrings
# 'sphinx.ext.napoleon'
Expand Down Expand Up @@ -283,6 +284,9 @@ def run_apidoc(_):
'--module-first',
'--output-dir',
'./api/modules',
# this is expected to be run from the `docs` directory. Its possible
# to set it up to run from other places, but so far this has worked for
# us
'../src/py-opentimelineio/opentimelineio',
] + ignore_paths

Expand Down

0 comments on commit 264eae6

Please sign in to comment.