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

Add RTD config #63

Merged
merged 10 commits into from
Nov 7, 2023
Merged

Add RTD config #63

merged 10 commits into from
Nov 7, 2023

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Oct 24, 2023

Add .readthedocs.yaml and pin some documentation dependencies.

👀 https://petab-select--63.org.readthedocs.build/en/63/

Closes #7

Add some basic sphinx configuration.
WARNING: Cannot resolve forward reference in type annotations of "petab_select.misc.hash_parameter_dict": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.misc.hash_parameter_options": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.misc.hash_parameter_dict": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.misc.hash_parameter_options": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model.Model.get_parameter_values": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace.__init__": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace.get_estimated": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace.indices_to_parameters": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace.parameters_all": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace.parameters_to_indices": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace.parameters_to_model": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.decompress_parameter_values": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.decompress_parameter_values": name 'estimate' is not defined
WARNING: Cannot resolve forward reference in type annotations of "petab_select.model_subspace.ModelSubspace": name 'estimate' is not defined
@dweindl dweindl self-assigned this Nov 7, 2023
@dweindl dweindl mentioned this pull request Nov 7, 2023
@codecov-commenter
Copy link

codecov-commenter commented Nov 7, 2023

Codecov Report

Merging #63 (bfa9980) into develop (b15a59c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop      #63   +/-   ##
========================================
  Coverage    60.48%   60.48%           
========================================
  Files           14       14           
  Lines         1516     1516           
========================================
  Hits           917      917           
  Misses         599      599           

dweindl and others added 2 commits November 7, 2023 09:38
Co-authored-by: Dilan Pathirana <[email protected]>
Add .readthedocs.yaml and pin some documentation dependencies.
More recent versions of nbsphin/sphinx/nbconvert require newer
pandoc than available on the RTD ubuntu-images.

:eyes: https://petab-select--63.org.readthedocs.build/en/63/

Closes #7
Base automatically changed from doc_sphinx to develop November 7, 2023 13:33
@dweindl dweindl marked this pull request as ready for review November 7, 2023 13:41
@dweindl dweindl removed their assignment Nov 7, 2023
@dweindl dweindl requested a review from dilpath November 7, 2023 13:41
Copy link
Member

@dilpath dilpath left a comment

Choose a reason for hiding this comment

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

Thanks for resolving the pandoc version issue!

@@ -89,12 +89,16 @@ def absolute_links(txt):
# 'pypesto @ git+https://github.com/ICB-DCM/pyPESTO.git@develop#egg=pypesto',
],
'doc': [
'sphinx>=3.5.3',
'sphinx>=3.5.3,<7',
Copy link
Member

Choose a reason for hiding this comment

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

Can this <7 be removed when the lower # pin comment is removed?

If so then

Suggested change
'sphinx>=3.5.3,<7',
# remove <7 when below nbsphinx==0.9.1 and nbconvert<7.5.0 are unpinned
'sphinx>=3.5.3,<7',

Copy link
Member Author

Choose a reason for hiding this comment

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

Honestly, I don't know. It's usually trial-and-error with the documentation stack... 🙈

@dweindl dweindl merged commit 2bb3076 into develop Nov 7, 2023
3 checks passed
@dweindl dweindl deleted the setup_rtd branch November 7, 2023 14:07
@dweindl dweindl linked an issue Nov 20, 2023 that may be closed by this pull request
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.

Host docs on Read the Docs
3 participants