Skip to content

Update documentation requirements to latest version#2225

Merged
gsheni merged 31 commits into
mainfrom
update_dev_reqs
Aug 9, 2022
Merged

Update documentation requirements to latest version#2225
gsheni merged 31 commits into
mainfrom
update_dev_reqs

Conversation

@gsheni

@gsheni gsheni commented Aug 5, 2022

Copy link
Copy Markdown
Contributor

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

codecov Bot commented Aug 5, 2022

Copy link
Copy Markdown

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

gsheni commented Aug 8, 2022

Copy link
Copy Markdown
Contributor Author

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

gsheni commented Aug 8, 2022

Copy link
Copy Markdown
Contributor Author
  • The codecov error can be ignored

Comment thread release.md Outdated
@gsheni gsheni enabled auto-merge (squash) August 8, 2022 21:56
Comment thread release.md Outdated
Co-authored-by: Shripad Badithe <60528327+sbadithe@users.noreply.github.com>
Comment thread .github/workflows/build_docs.yaml
Comment thread release.md Outdated
Comment thread release.md Outdated
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>
@gsheni gsheni requested review from sbadithe and tamargrey August 9, 2022 14:20
* 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
Copy Markdown
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`

@rwedge rwedge left a comment

Copy link
Copy Markdown
Contributor

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.

4 participants