From 32b8c8b7b3900a9c6339cee3c149a4f8096a299f Mon Sep 17 00:00:00 2001 From: "LAPTOP-MB0HU4QI\\Mostapha" Date: Wed, 13 Mar 2019 22:22:42 -0400 Subject: [PATCH] docs(travis): Added documentation deployment to travis --- .travis.yml | 13 +++++++++++++ docs/_build/docs/README.md | 1 + docs/conf.py | 4 +++- 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/_build/docs/README.md diff --git a/.travis.yml b/.travis.yml index dfb8b095..fca3b19d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -26,3 +26,16 @@ jobs: - git config --global user.email "release@ladybug.tools" - pip install python-semantic-release - semantic-release publish + # generate updated documentation + - pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme + - sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug ./ladybug/euclid.py + - sphinx-build -b html ./docs ./docs/_build/docs + # deploy to github pages + # https://docs.travis-ci.com/user/deployment/pages/ + provider: pages + skip_cleanup: true + github-token: $GH_TOKEN + keep-history: false + on: + branch: master + local_dir: docs/_build/ \ No newline at end of file diff --git a/docs/_build/docs/README.md b/docs/_build/docs/README.md new file mode 100644 index 00000000..551d1290 --- /dev/null +++ b/docs/_build/docs/README.md @@ -0,0 +1 @@ +# place holder for documentation diff --git a/docs/conf.py b/docs/conf.py index fc97500f..3816b171 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,9 @@ author = 'Ladybug Tools' # The short X.Y version -version = '0.2.0' +import ladybug +version = ladybug.__version__ + # The full version, including alpha/beta/rc tags release = ''