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.

Sign up for GitHub

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

Jump to bottom

Create parameters description in the documentation #33

Merged
merged 17 commits into from
Apr 18, 2024
Merged

Create parameters description in the documentation #33

merged 17 commits into from
Apr 18, 2024

Conversation

nico-canta
Copy link
Collaborator

@nico-canta nico-canta commented Apr 15, 2024 •
edited by matz-e
Loading

  • Switch to Python 3.11
  • Compile petsc4py manually with the correct Cython
  • Mock petsc4py on ReadTheDocs to accelerate documentation building (takes a few minutes less)

@nico-canta nico-canta marked this pull request as ready for review April 15, 2024 16:05
@nico-canta nico-canta marked this pull request as draft April 15, 2024 16:06
matz-e
matz-e reviewed Apr 16, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@matz-e matz-e force-pushed the nicola/params_page branch 10 times, most recently from 68c2f3f to 65ee4bb Compare April 17, 2024 09:05
@matz-e matz-e force-pushed the nicola/params_page branch from 65ee4bb to f9678bc Compare April 17, 2024 09:08
matz-e and others added 2 commits April 17, 2024 13:55
@matz-e
Attempt to fix RTD build
c89a731 
Mock petsc4py imports to avoid building things on RTD, and fix the
docutils version to something that works with m2r2
@nico-canta
add toctree
9543c49
@nico-canta
Copy link
Collaborator Author

Hi @cattabiani,
now in the documentation, there are links to VasculatureParams. For example here
https://astrovascpy--33.org.readthedocs.build/33/generated/astrovascpy.bloodflow.html#astrovascpy.bloodflow.update_static_flow_pressure

The docstring of this class describes all the parameters used in the model. Does it work well for you?

@nico-canta nico-canta marked this pull request as ready for review April 17, 2024 16:20
@nico-canta nico-canta requested a review from matz-e April 17, 2024 16:20
matz-e
matz-e reviewed Apr 18, 2024
View reviewed changes
.github/workflows/test.yml Show resolved Hide resolved
astrovascpy/typing.py Outdated Show resolved Hide resolved
@nico-canta nico-canta merged commit 97b76eb into main Apr 18, 2024
4 checks passed
@nico-canta nico-canta deleted the nicola/params_page branch April 18, 2024 12:29
@nico-canta nico-canta mentioned this pull request Apr 19, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matz-e matz-e matz-e approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nico-canta @matz-e