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

Create configuration file for Read the Docs #1187

Merged
merged 1 commit into from
Aug 2, 2023

Conversation

mtar
Copy link
Collaborator

@mtar mtar commented Aug 2, 2023

Due Diligence

  • General:
    • base branch must be main for new features, latest release branch (e.g. release/1.3.x) for bug fixes
    • title of the PR is suitable to appear in the Release Notes
  • Implementation:
    • unit tests: all split configurations tested
    • unit tests: multiple dtypes tested
    • documentation updated where needed

Description

This Pull Request introduces a configuration file which is now required for Read the Docs.

Issue/s resolved: #1185

Changes proposed:

  • add .readthedocs.yaml

Type of change

  • Documentation update

Memory requirements

Performance

Does this change modify the behaviour of other functions? If so, which?

no

@mtar mtar added the documentation Anything related to documentation label Aug 2, 2023
@ghost
Copy link

ghost commented Aug 2, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023

Thank you for the PR!

@codecov
Copy link

codecov bot commented Aug 2, 2023

Codecov Report

❗ No coverage uploaded for pull request base (release/1.3.x@c50c1d2). Click here to learn what that means.
The diff coverage is n/a.

@@               Coverage Diff                @@
##             release/1.3.x    #1187   +/-   ##
================================================
  Coverage                 ?   92.17%           
================================================
  Files                    ?       75           
  Lines                    ?    10703           
  Branches                 ?        0           
================================================
  Hits                     ?     9865           
  Misses                   ?      838           
  Partials                 ?        0           
Flag Coverage Δ
unit 92.17% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@ClaudiaComito ClaudiaComito left a comment

Choose a reason for hiding this comment

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

Great thanks @mtar!

@ClaudiaComito ClaudiaComito added this to the Repo Clean-Up milestone Aug 2, 2023
@ClaudiaComito ClaudiaComito linked an issue Aug 2, 2023 that may be closed by this pull request
@ClaudiaComito ClaudiaComito merged commit 4338622 into release/1.3.x Aug 2, 2023
42 checks passed
@ClaudiaComito ClaudiaComito deleted the docs/1185-rtd-configuration-file branch August 2, 2023 09:50
ClaudiaComito added a commit that referenced this pull request Aug 4, 2023
* update version to 1.3.0

* Create .readthedocs.yaml (#1187)

* Update heat/core/version.py

---------

Co-authored-by: Michael Tarnawa <m.tarnawa@fz-juelich.de>
ClaudiaComito added a commit that referenced this pull request Sep 25, 2023
* update version to 1.3.0

* Create .readthedocs.yaml (#1187)

* Update communication.py - reworked wrapper for gather-ops and some smaller stuff

* Update printing.py - replaced `gather`(mpi4py fallback) by `Gatherv` (Heat)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* small formatting change

* commented out tests in random in order to determine the source of errors

* commented out DASO-tests for finding errors....

* finding bugs...

* ...

* ...

* smaller changes to improve codecov

* Update version extension to "dev"

* Fix string

---------

Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: Michael Tarnawa <m.tarnawa@fz-juelich.de>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Hoppe <mrhf92@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Badge says that docs are failing
2 participants