Skip to content

Commit

Permalink
hotfix: add handling for testing locally on 1.7.4 sphinx and removed …
Browse files Browse the repository at this point in the history
…debug statements
  • Loading branch information
asampat3090 committed May 6, 2018
1 parent cdf74f0 commit 396ca33
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 7 deletions.
3 changes: 2 additions & 1 deletion devtools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ $ python setup.py clean --all install

## Local Documentation Build
```
$ pip install sphinx-argparse
$ pip install sphinx==1.7.4
$ pip install sphinx-argparse==0.2.2
$ cd docs
$ rm -rf source/*
$ make clean
Expand Down
6 changes: 1 addition & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,18 +163,14 @@
github_doc_root = 'https://github.com/datmo/datmo/tree/master/docs/'

def setup(app):
print("running sphinx-api-doc")
app.connect('builder-inited', run_apidoc)
print("added config value for markdown")
app.add_config_value('recommonmark_config', {
'url_resolver': lambda url: github_doc_root + url,
'auto_toc_tree_section': 'Contents',
}, True)
print("add autostructify transform")
app.add_transform(AutoStructify)

def run_apidoc(_):
from sphinx.apidoc import main
from sphinx.ext.apidoc import main
import os
import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
Expand Down
2 changes: 1 addition & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ channels:
- conda-forge
dependencies:
- python=2.7
- sphinx=1.7.0
- sphinx=1.7.4
- sphinx-argparse=0.2.2
- pip:
- autodocsumm

0 comments on commit 396ca33

Please sign in to comment.