Skip to content

Commit

Permalink
Fix documentation:
Browse files Browse the repository at this point in the history
Build api_reference
Add link to source code to conf.py to make source links available in API reference
Update version in doc conf.py
Add future to required packages in setup.py
  • Loading branch information
Maximilian Schmidt committed Apr 19, 2018
1 parent 50b0b23 commit f8b7009
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 16 deletions.
2 changes: 2 additions & 0 deletions doc/.readthedocs.yml
@@ -0,0 +1,2 @@
python:
setup_py_install: true
10 changes: 5 additions & 5 deletions doc/conf.py
Expand Up @@ -16,10 +16,10 @@
# 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.
#
# import os
import os
import sys
sys.path.insert(0, '../')

sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('../h5py_wrapper'))

# -- General configuration ------------------------------------------------

Expand Down Expand Up @@ -58,9 +58,9 @@
# built documents.
#
# The short X.Y version.
version = u'1.0'
version = u'1.1'
# The full version, including alpha/beta/rc tags.
release = u'1.0.0'
release = u'1.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
20 changes: 10 additions & 10 deletions doc/release_notes.rst
Expand Up @@ -28,9 +28,9 @@ The deprecated functions `add_to_h5` and `load_h5` were removed.
Contributors
++++++++++++

Maximilian Schmidt
Jakob Jordan
Julia Sprenger
- Maximilian Schmidt
- Jakob Jordan
- Julia Sprenger

1.0.1
=====
Expand All @@ -56,8 +56,8 @@ This has the effect that old files created with release version 0.0.1 cannot be
Contributors
++++++++++++

Maximilian Schmidt
Jakob Jordan
- Maximilian Schmidt
- Jakob Jordan

v0.0.1
======
Expand All @@ -74,8 +74,8 @@ Contributors

(in alphabetical order)

Hannah Bos
Michael Denker
Jakob Jordan
Maximilian Schmidt
Jannis Schuecker
- Hannah Bos
- Michael Denker
- Jakob Jordan
- Maximilian Schmidt
- Jannis Schuecker
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -13,7 +13,7 @@
packages=['h5py_wrapper', 'tests'],
python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*, !=3.4.*, <4',
scripts=['convert_h5file'],
install_requires=['h5py', 'pytest-runner'],
install_requires=['h5py', 'pytest-runner', 'future'],
tests_require=['pytest'],
long_description=open('README.rst').read(),
classifiers=[
Expand Down

0 comments on commit f8b7009

Please sign in to comment.