Skip to content

BLD: build docs on Azure Pipelines #909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Feb 26, 2020
Merged

BLD: build docs on Azure Pipelines #909

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
0a79de5
try building docs on Azure Pipelines
Feb 23, 2020
b72d2ba
add doc.yml conda env file
Feb 24, 2020
de103d8
specify conda env name
Feb 24, 2020
e1c954b
fix doc -> docs
Feb 24, 2020
087bf98
include sphinx-gallery
Feb 24, 2020
ca3c406
add pytest to env
Feb 24, 2020
0d6d085
install library to run sphinx-gallery
Feb 24, 2020
60079da
install full suite of pvlib dependencies
Feb 24, 2020
4c6f691
remove 'warnings as errors' flag
Feb 24, 2020
97b28ca
return standard tests to azure-pipelines.yml
Feb 24, 2020
e5203a8
fix job spacing
Feb 25, 2020
fc86bc9
add to what's new
Feb 25, 2020
31284f3
Merge branch 'master' into ci_doctest
CameronTStark Feb 25, 2020
6e2c13d
remove unused doc.yml config
Feb 25, 2020
98e18d4
use requirements-py38.yml for docbuilding
Feb 25, 2020
f7e17cc
remove conda environment
Feb 25, 2020
5bbfad2
more conda removal
Feb 25, 2020
fbb2a7a
specify python 3.8
Feb 26, 2020
19c49f6
additional cleanup
Feb 26, 2020
fe93409
test docs before publish, rename env build
Feb 26, 2020
c07563d
Merge branch 'master' into ci_doctest
CameronTStark Feb 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions azure-pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,3 +194,24 @@ jobs:

- script: python setup.py sdist
displayName: 'Build sdist'


- job: DocsTest
pool:
vmImage: 'ubuntu-16.04'
steps:
- bash: echo "##vso[task.prependpath]/usr/share/miniconda/bin"
displayName: Add conda to PATH
- script: conda env create -n test_env --quiet --file ci/doc.yml
displayName: Create Anaconda environment
- script: |
source activate test_env
# Replicate the exact environment created by the readthedocs CI
# conda install --yes --quiet -c pkgs/main mock pillow sphinx sphinx_rtd_theme
pip install -e .[all]
displayName: Replicate readthedocs CI environment
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

install pvlib for doc build?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is necessary to run the sphinx-gallery examples at least. I was inspired by xarray's Azure config and this is also a step that xarray uses as well.

Based on the readthedocs.yml file, isn't this at least part of how ReadTheDocs builds our documentation for us? In our readthedocs.yml file it states that the extra_requirements are listed as -all and based on The ReadTheDocs documentation that is what is installed during their build of our docs. I'm inexperienced with ReadTheDocs so please let me know if I am missing something.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we're on the same page here. My comment should have been a suggestion like

    displayName: Install pvlib[all] for doc build

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that better, thanks for the recommendation.

- script: |
source activate test_env
cd docs/sphinx/
sphinx-build -j auto -b html -d _build/doctrees source build
displayName: Build HTML docs
28 changes: 28 additions & 0 deletions ci/doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: xarray-docs
channels:
# Don't change to pkgs/main, as it causes random timeouts in readthedocs
- conda-forge
dependencies:
- python=3.8
- bottleneck
- cartopy
- cfgrib
- h5netcdf
- ipykernel
- ipython
- iris
- jupyter_client
- nbsphinx
- netcdf4
- numba
- numpy
- numpydoc
- pandas
- pytest
- rasterio
- seaborn
- setuptools
- sphinx
- sphinx_rtd_theme
- sphinx-gallery
- zarr
2 changes: 2 additions & 0 deletions docs/sphinx/source/whatsnew/v0.7.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,14 @@ Bug fixes
0.6.4 what's new file. (:issue:`898`)
* Compatibility with cftime 1.1. (:issue:`895`)
* Add Python3.8 to Azure Pipelines CI (:issue:`903`)(:pull:`904`)
* Add documentation build test to Azure Pipelines CI (:pull:`909`)
* Minor implemention changes to avoid runtime and deprecation warnings in
:py:func:`~pvlib.clearsky.detect_clearsky`,
:py:func:`~pvlib.iam.martin_ruiz_diffuse`,
:py:func:`~pvlib.losses.soiling_hsu`,
and various test functions.


Documentation
~~~~~~~~~~~~~
* Add NumFOCUS affiliation to Sphinx documentation (:pull:`862`)
Expand Down