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

Updated version of documentation #449

Merged
merged 40 commits into from
Nov 19, 2024

Conversation

damienmarchal
Copy link
Contributor

@damienmarchal damienmarchal commented Sep 13, 2024

Fix the documentation to make the sphinx documentation generation works.

hugtalbot and others added 3 commits September 5, 2023 15:56
# Conflicts:
#	Plugin/src/SofaPython3/Prefab.cpp
#	bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseMeshTopology.cpp
#	bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_ObjectFactory_doc.h
#	bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Topology.cpp
#	bindings/Sofa/src/SofaPython3/Sofa/Simulation/Submodule_Simulation.cpp
CMakeLists.txt Outdated Show resolved Hide resolved
@hugtalbot
Copy link
Contributor

This PR should be rebased

@hugtalbot hugtalbot changed the title Updated version of documentation. Updated version of documentation Oct 2, 2024
@damienmarchal
Copy link
Contributor Author

I'm so happy to rebase branch dating back from years.

@damienmarchal
Copy link
Contributor Author

@hugtalbot it is rebased and tests are passing

- created
- edited
workflow_dispatch: # This allows manual triggering

Copy link
Contributor

Choose a reason for hiding this comment

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

so cool thanks a lot @damienmarchal for the action ❤️
Have you tested on your branch?

Copy link
Contributor Author

@damienmarchal damienmarchal Nov 8, 2024

Choose a reason for hiding this comment

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

I don't even remember having writing that :)
So no idea how I can trigger le build_doc stuff :)

Copy link
Contributor

Choose a reason for hiding this comment

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

@damienmarchal Since the entire PR is fine and the GitHub action should be assessed, we would suggest to remove the action from the PR and merge. It would allow to test the action separately.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done :)

.github/workflows/build_docs.yml Outdated Show resolved Hide resolved
CMakeLists.txt Outdated Show resolved Hide resolved
os: "ubuntu-22.04"
commands:
- mkdir --parents $READTHEDOCS_OUTPUT/html/
- wget https://github.com/sofa-framework/SofaPython3/releases/download/release-v23.06/SofaPython3_v23.06_docs.zip
Copy link
Contributor

Choose a reason for hiding this comment

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

v23.06?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, the doc was done at that time and as we have to manually update things I would prefer to first merge something that works then update the build process to remove the manual parts.

@hugtalbot hugtalbot merged commit d98fb54 into sofa-framework:master Nov 19, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request pr: status ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants