Skip to content
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.

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

Update documentation requirements to latest version #2225

Merged
merged 31 commits into from Aug 9, 2022
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/build_docs.yaml
Expand Up @@ -5,6 +5,9 @@ on:
branches:
- main

env:
PYARROW_IGNORE_TIMEZONE: 1
gsheni marked this conversation as resolved.
Show resolved Hide resolved

name: Build Docs
jobs:
build_docs:
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/create_feedstock_pr.yaml
@@ -1,8 +1,8 @@
on:
workflow_dispatch:
inputs:
pypi_version:
description: 'released PyPI version to use (include v, example v1.11.1)'
version:
description: 'released PyPI version to use (ex - v1.11.1)'
required: true

name: Create Feedstock PR
Expand All @@ -15,7 +15,7 @@ jobs:
uses: actions/checkout@v3
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.inputs.pypi_version }}
ref: ${{ github.event.inputs.version }}
path: "./featuretools"
- name: Pull latest from upstream for user forked feedstock
run: |
Expand All @@ -34,7 +34,7 @@ jobs:
uses: alteryx/create-feedstock-meta-yaml@v3
with:
project: "featuretools"
pypi_version: ${{ github.event.inputs.pypi_version }}
pypi_version: ${{ github.event.inputs.version }}
setup_cfg_filepath: "featuretools/setup.cfg"
meta_yaml_filepath: "featuretools-feedstock/recipe/meta.yaml"
add_to_test_requirements: "graphviz !=2.47.2"
Expand All @@ -47,10 +47,10 @@ jobs:
git config --global user.email "machineOSS@alteryx.com"
git config --global user.name "machineAYX Bot"
git remote set-url origin https://${{ secrets.AUTO_APPROVE_TOKEN }}@github.com/alteryx/featuretools-feedstock
git checkout -b conda-autocreate-${{ github.event.inputs.pypi_version }}
git checkout -b ${{ github.event.inputs.version }}
git add recipe/meta.yaml
git commit -m "auto commit"
git push origin conda-autocreate-${{ github.event.inputs.pypi_version }}
git push origin ${{ github.event.inputs.version }}
- name: Adding URL to job output
run: |
echo "Conda Feedstock Pull Request: https://github.com/alteryx/featuretools-feedstock/pull/new/conda-autocreate-${{ github.event.inputs.pypi_version }}" >> $GITHUB_STEP_SUMMARY
echo "Conda Feedstock Pull Request: https://github.com/alteryx/featuretools-feedstock/pull/new/${{ github.event.inputs.version }}" >> $GITHUB_STEP_SUMMARY
4 changes: 2 additions & 2 deletions .readthedocs.yaml
Expand Up @@ -10,7 +10,7 @@ sphinx:
configuration: docs/source/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
formats: all
formats: []

# Optionally set the version of Python and requirements required to build your docs
python:
Expand All @@ -19,4 +19,4 @@ python:
- method: pip
path: .
extra_requirements:
- dev
- docs
10 changes: 6 additions & 4 deletions docs/source/conf.py
Expand Up @@ -103,7 +103,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -154,6 +154,8 @@
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"pygment_light_style": "tango",
"pygment_dark_style": "native",
"icon_links": [
{
"name": "GitHub",
Expand Down Expand Up @@ -377,9 +379,9 @@
nbsphinx_execute = "auto"

extlinks = {
"issue": ("https://github.com/alteryx/featuretools/issues/%s", "GH#"),
"pr": ("https://github.com/alteryx/featuretools/pull/%s", "GH#"),
"user": ("https://github.com/%s", "@"),
"issue": ("https://github.com/alteryx/featuretools/issues/%s", "GH#%s"),
"pr": ("https://github.com/alteryx/featuretools/pull/%s", "GH#%s"),
"user": ("https://github.com/%s", "@%s"),
}

# Napoleon settings
Expand Down
1 change: 1 addition & 0 deletions docs/source/release_notes.rst
Expand Up @@ -13,6 +13,7 @@ Future Release
* Documentation Changes
* Testing Changes
* Update create feedstock PR forked repo to use (:pr:`2223`)
* Update development requirements and use latest for documentation (:pr:`2225`)

Thanks to the following people for contributing to this release:
:user:`gsheni`, :user:`ozzieD`, user:`sbadithe`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
:user:`gsheni`, :user:`ozzieD`, user:`sbadithe`
:user:`gsheni`, :user:`ozzieD`, :user:`sbadithe`

Expand Down
19 changes: 11 additions & 8 deletions release.md
Expand Up @@ -82,18 +82,21 @@ After the release pull request has been merged into the `main` branch, it is tim

## Release on conda-forge

In order to release on conda-forge, you can either wait for a bot to create a PR, or manually kickoff the creation with GitHub Actions
In order to release on conda-forge, you can either wait for a bot to create a pull request, or manually kickoff the creation with GitHub Actions

### Option 1: Manually create the new PR with GitHub Actions
### Option 1: Manually create the new pull request with GitHub Actions
1. Go to this GitHub Action: https://github.com/alteryx/featuretools/actions/workflows/create_feedstock_pr.yaml
2. Input the released version with the v prefix (e.g. v0.13.3)
3. Kickoff the GitHub action, and monitor the Job Summary.
2. Click **Run workflow** and input the released version with the v prefix (e.g. `v0.13.3`)
gsheni marked this conversation as resolved.
Show resolved Hide resolved
3. Kickoff the GitHub Action, and monitor the Job Summary.
4. At the completion of the job, you should see summary output, with a URL.
* You will need to visit this URL, and create a PR.
* You can also create the PR by clicking the branch name (ex - `conda-autocreate-v0.13.3`):
* You will need to visit this URL, and create a pull request.
gsheni marked this conversation as resolved.
Show resolved Hide resolved
* You can also create the pull request by clicking the branch name (e.g. - `v0.13.3`):
gsheni marked this conversation as resolved.
Show resolved Hide resolved
- https://github.com/alteryx/featuretools-feedstock/branches
5. Verify the `requirements['run']` (in __recipe/meta.yml__) match the `install_requires` in __featuretools/setup.cfg__.
* Verify the `test['requires']` (in __recipe/meta.yml__) match the test requirements in `[options.extras_require]` in __featuretools/setup.cfg__
5. Verify that the PR has the following:
* The `build['number']` is 0 (in __recipe/meta.yml__).
* The `requirements['run']` (in __recipe/meta.yml__) match the `install_requires` in __woodwork/setup.cfg__.
* The `test['requires']` (in __recipe/meta.yml__) match the test requirements in `[options.extras_require]` in __woodwork/setup.cfg__
gsheni marked this conversation as resolved.
Show resolved Hide resolved
6. Satisfy the conditions in pull request description and **merge it if the CI passes**.

### Option 2: Waiting for bot to create new PR

Expand Down
30 changes: 17 additions & 13 deletions setup.cfg
Expand Up @@ -45,7 +45,7 @@ install_requires =
click >= 7.0.0
cloudpickle >= 1.5.0
dask[dataframe] >= 2021.10.0, <2022.8.0
distributed >= 2021.10.0
distributed >= 2021.10.0, <2022.8.0
holidays >= 0.13
numpy >= 1.21.0
packaging >= 20.0
Expand All @@ -57,24 +57,28 @@ install_requires =
python_requires = >=3.8, <4

[options.extras_require]
dev =
docs =
scikit-learn >=0.20.0, !=0.22
flake8 == 4.0.1
ipython == 7.31.1
isort == 5.9.3
black[jupyter] == 22.3.0
ipython == 8.4.0
jupyter == 1.0.0
matplotlib == 3.3.3
nbconvert == 6.4.5
nbsphinx == 0.8.7
pydata-sphinx-theme== 0.7.1
Sphinx == 4.2.0
matplotlib == 3.5.2
Sphinx == 5.1.1
nbsphinx == 0.8.9
nbconvert == 6.5.0
pydata-sphinx-theme == 0.9.0
sphinx-inline-tabs == 2022.1.2b11
sphinx-copybutton == 0.4.0
myst-parser == 0.16.1
sphinx-copybutton == 0.5.0
myst-parser == 0.18.0
nlp_primitives >= 2.3.0
autonormalize >= 2.0.1
%(spark)s
%(test)s
dev =
flake8 == 5.0.4
isort == 5.10.1
black[jupyter] == 22.6.0
pre-commit >= 2.20.0
%(docs)s
%(spark)s
%(test)s
test =
Expand Down