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

Conversation

gsheni
Copy link
Contributor

@gsheni gsheni commented Aug 5, 2022

@gsheni gsheni self-assigned this Aug 5, 2022
@codecov
Copy link

codecov bot commented Aug 5, 2022

Codecov Report

Merging #2225 (3f12770) into main (7f25720) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #2225      +/-   ##
==========================================
- Coverage   99.29%   99.29%   -0.01%     
==========================================
  Files         146      146              
  Lines       17583    17577       -6     
==========================================
- Hits        17459    17453       -6     
  Misses        124      124              
Impacted Files Coverage Δ
featuretools/utils/gen_utils.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@gsheni gsheni marked this pull request as ready for review August 5, 2022 19:41
@gsheni gsheni requested a review from rwedge August 5, 2022 19:49
@gsheni gsheni changed the title Update development requirements to latest version Update development & documentation requirements to latest version Aug 8, 2022
@gsheni gsheni requested a review from sbadithe August 8, 2022 19:56
@gsheni gsheni requested a review from tamargrey August 8, 2022 19:56
@gsheni
Copy link
Contributor Author

gsheni commented Aug 8, 2022

I was originally going to use a .readthedocs.yml file as below. However, this resulted in a significant increase in ru ntime 455 seconds to 594 seconds. Therefore I kept the existing format. It seems strange that readthedocs has the Spark requirements, graphviz, and pandoc installed (without specifying it in .readthedocs.yaml)

# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-20.04
  tools:
    python: "3.8"
  apt_packages:
    - pandoc
    - graphviz
    - openjdk-11-jre-headless
  jobs:
    post_create_environment:
      - export PYARROW_IGNORE_TIMEZONE=1
      - export JAVA_HOME="/usr/lib/jvm/java-11-openjdk-amd64"

# Build documentation in the docs/ directory with Sphinx
sphinx:
  configuration: docs/source/conf.py

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

# Optionally set the version of Python and requirements required to build your docs
python:
  install:
    - method: pip
      path: .
      extra_requirements:
        - docs

@gsheni
Copy link
Contributor Author

gsheni commented Aug 8, 2022

  • The codecov error can be ignored

release.md Outdated Show resolved Hide resolved
@gsheni gsheni enabled auto-merge (squash) August 8, 2022 21:56
release.md Outdated Show resolved Hide resolved
Co-authored-by: Shripad Badithe <60528327+sbadithe@users.noreply.github.com>
release.md Outdated Show resolved Hide resolved
release.md Outdated Show resolved Hide resolved
gsheni and others added 2 commits August 8, 2022 19:20
Co-authored-by: Shripad Badithe <60528327+sbadithe@users.noreply.github.com>
Co-authored-by: Shripad Badithe <60528327+sbadithe@users.noreply.github.com>
@@ -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`

Copy link
Contributor

@rwedge rwedge left a comment

Choose a reason for hiding this comment

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

LGTM, left one suggested change

@gsheni gsheni merged commit b3cebed into main Aug 9, 2022
@gsheni gsheni deleted the update_dev_reqs branch August 9, 2022 15:28
@gsheni gsheni changed the title Update development & documentation requirements to latest version Update documentation requirements to latest version Aug 9, 2022
@ozzieD ozzieD mentioned this pull request Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants