Docs #99
Docs #99
Conversation
ocefpaf
left a comment
ocefpaf
left a comment
There was a problem hiding this comment.
Note that I moved all the files from the doc page to docs/NOTES to avoid conflicting with the "new" docs.
We should migrate those to the new docs later.
| @@ -1,3 +1,5 @@ | |||
| # use http://lint.travis-ci.org/ to check the file. | |||
There was a problem hiding this comment.
Just a reminder on how to check the file.
|
|
||
| env: | ||
| global: | ||
| - secure:` "yxu/J/VNed5R6Fs1D5YJZ9hN3bMFAOBxFOkVyoxSfzTsDWeJ0rNLMljn7TTFeBBFpNI6PG3RFIzeOd3AAbtZKr4dQ/aL70woQ2nF7lNDbofudE+bdc/K0fKhS4dZZeMKyeRI3LItQgGJ1vSOYDGfpq0EhOd17d1oo9pqjDli+pTzjJ6qvDQ41e5mmRPVXIqJ2mLpnf+jZdvHJTzog0d4kS+BQOqhLYe1AATyYyHFrs95kroAVkLbuPhQ0KVQX3h8NV3OD+x+qQjmM2Zl6mygoABh8jbkAv2/Kx/WcBR/rLO6WG2z+ZBwdP/2R7/Gh0Tac9An+Kvf8L1GCdyeMoS55XlUTwyqbpOQydASs8PlGnQuNFk3QaeJcjWJgFJjoYUDC8yQt/avkjkiPPa6kraUQalEYD66t5dKrL2UICCUUJ4lXkHGD532tLOFS2dJTRRgUQD/d8q4cNzdNY9X4LaHYDJxhFWi+sV/gOYrSSc1uF4pxlpU8naBR/eaJHN1+eGb5h76LC1uF7zcjYLFmsP+YmMVwyVKU3bbcPmHNsoDgrtAY0bF4gDVLDeqmZzt4OLz9ATtHNRST9yEjmiyjUXX9O+kXYFGOd14XMw+S0vdqwSPeobavFTaUmz0+AUQiPkJf0FpLbHmUHfY/0m3PvlwQYFyskgYzjjhNtR362fCtgg=" |
There was a problem hiding this comment.
This allows for doctr to push to gh-pages.
| - export PATH="$HOME/miniconda/bin:$PATH" | ||
| - conda config --set always_yes yes --set changeps1 no --set show_channel_urls true | ||
| - conda update conda | ||
| - conda config --add channels conda-forge --force |
There was a problem hiding this comment.
We need this to install doctr and other modules.
Ideally we should migrate the odm2 channel to conda-forge to avoid the need for 3 channels.
There was a problem hiding this comment.
Ideally we should migrate the odm2 channel to conda-forge to avoid the need for 3 channels.
Thanks for the reminder. Let's discuss it in the near future, say, starting next week (not this week)
| make clean html linkcheck ; | ||
| popd ; | ||
| python -m doctr deploy --sync .; | ||
| python -m doctr deploy --sync --no-require-master --built-docs docs/build/html "docs-$TRAVIS_BRANCH" ; |
There was a problem hiding this comment.
In this section we:
- install
doctr. - build the docs from scratch and check the links.
- push to both the
/and thedocs-versiondirectory so we can have latest and versioned docs;
| @@ -0,0 +1,20 @@ | |||
| # Minimal makefile for Sphinx documentation | |||
There was a problem hiding this comment.
Boilerplate generated with sphinx-quickstart.
| @@ -0,0 +1,177 @@ | |||
| # -*- coding: utf-8 -*- | |||
There was a problem hiding this comment.
This file is mostly boilerplate from sphinx-quickstart but I made a few tweaks to customize the docs page.
| @@ -0,0 +1,7 @@ | |||
| :mod:`ODMconnection` | |||
There was a problem hiding this comment.
This is only an example. We can add all the modules later once this is working.
| flake8-print | ||
| flake8-quotes | ||
| mock | ||
| nbsphinx |
There was a problem hiding this comment.
With this extension we can convert Jupyter notebooks examples to docs.
There was a problem hiding this comment.
Fantastic! I like the example from the folium docs
I'm fine with what you did. All those documents are old, most of them are 2 years old. And at least a couple of them are actually old, manual attempts (by Stephanie?) at documenting the API. So, they'll be replaced by or integrated into the Sphinx system we're building. |
2 participants
Here is a demo that I force pushed earlier today:
http://odm2.github.io/ODM2PythonAPI/
There are still a few things to adjust and I am having trouble with latest
doctr. Looking into it...