mirror of
https://github.com/vale981/jobmanager
synced 2025-03-04 17:31:39 -05:00
building docs requires package numpydoc
. Added viewcode mod.
This commit is contained in:
parent
49ecd70e2f
commit
72eade51e0
3 changed files with 5 additions and 5 deletions
|
@ -1,4 +1,8 @@
|
|||
#### jobmanager documentation
|
||||
Install [numpydoc](https://pypi.python.org/pypi/numpydoc):
|
||||
|
||||
pip install numpydoc
|
||||
|
||||
To compile the documentation, run
|
||||
|
||||
python setup.py build_sphinx
|
||||
|
|
|
@ -24,10 +24,7 @@ import os
|
|||
sys.path.insert(0, os.path.abspath(os.path.join(os.path.abspath(
|
||||
os.path.dirname(__file__)), '../')))
|
||||
|
||||
sys.path.append(os.path.abspath('_extensions'))
|
||||
|
||||
# include examples
|
||||
|
||||
sys.path.append(os.path.abspath(os.path.dirname(__file__)+"/../examples"))
|
||||
|
||||
|
||||
|
@ -69,7 +66,7 @@ extensions = [
|
|||
# 'inheritance_diagram',
|
||||
# 'hidden_code_block',
|
||||
'sphinx.ext.autosummary',
|
||||
# 'sphinx.ext.viewcode',
|
||||
'sphinx.ext.viewcode',
|
||||
'numpydoc',
|
||||
]
|
||||
|
||||
|
|
1
setup.py
1
setup.py
|
@ -43,7 +43,6 @@ except:
|
|||
setup(
|
||||
name=name,
|
||||
author=author,
|
||||
authors=authors,
|
||||
url='https://github.com/cimatosa/jobmanager',
|
||||
version=version,
|
||||
packages=[name],
|
||||
|
|
Loading…
Add table
Reference in a new issue