Skip to content

Add documentation rendering#250

Open
fsimonis wants to merge 2 commits intodevelopfrom
add-docs-rendering
Open

Add documentation rendering#250
fsimonis wants to merge 2 commits intodevelopfrom
add-docs-rendering

Conversation

@fsimonis
Copy link
Member

@fsimonis fsimonis commented Oct 30, 2025

This PR adds minimal documentation rendering using sphinx.

The porting and release guide are included but not modified.

The build.sh creates a venv with all dependencies, installs pyprecice and then builds the documentation as a singlehtml.
Note that the pyprecice package needs to be installed for autodoc to extract the docstrings etc.

As a cleanup, some utilities could be marked as private.

Copy link
Member

@IshaanDesai IshaanDesai 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 this, much needed! It would make sense to add CI to re-render the docstrings documentation if it is updated via a PR or commit. Will this already be done via the submodules, or do we need to trigger it?

@fsimonis
Copy link
Member Author

Instead of the website integration, a valid option could be to use read the docs as deployment method.

It allows specifying the latest Ubuntu lts as OS and pre-build commands, so one could install the latest preCICE.

This could be a robust deployment method.

@fsimonis fsimonis marked this pull request as draft October 31, 2025 15:01
@fsimonis
Copy link
Member Author

I'll convert this to a draft until there is more certainty on how to proceed here precice/precice.github.io#630

rajatgaur07

This comment was marked as spam.

@precice precice deleted a comment from rajatgaur07 Mar 21, 2026
@precice precice deleted a comment from rajatgaur07 Mar 21, 2026
@fsimonis fsimonis marked this pull request as ready for review March 26, 2026 14:30
@IshaanDesai IshaanDesai self-requested a review March 26, 2026 15:03
Copy link
Member

@IshaanDesai IshaanDesai left a comment

Choose a reason for hiding this comment

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

I built the documentation and went through it in a web browser. It looks as expected 👍 thanks for getting this done.

@fsimonis fsimonis force-pushed the add-docs-rendering branch from 2afb902 to d20a679 Compare March 26, 2026 16:05
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.

3 participants