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

[docs] Fix documentations #8

Merged
merged 1 commit into from
Dec 13, 2024
Merged

[docs] Fix documentations #8

merged 1 commit into from
Dec 13, 2024

Conversation

Routhleck
Copy link
Collaborator

This pull request includes several updates to the documentation, including the addition of a new Makefile for Sphinx documentation, a comprehensive overview of the PINNx library, and restructuring of example files. The most important changes include the creation of a minimal makefile for Sphinx, a detailed description of PINNx's features and algorithms, and the reorganization of example documentation.

Documentation improvements:

  • docs/Makefile: Added a minimal makefile for Sphinx documentation, allowing easier management and building of documentation.
  • docs/about.rst: Added a detailed description of PINNx, including its features, algorithms, and integration with the Brain Dynamics Programming ecosystem.

Reorganization of example documentation:

Removal of outdated example documentation:

  • docs/examples-function.rst, docs/examples-operator.rst, docs/examples-pinn-forward.rst, docs/examples-pinn-inverse.rst: Removed outdated example documentation to streamline and update the examples provided. [1] [2] [3] [4]

Index restructuring:

  • docs/index.rst: Updated the index to include new sections for installation, quick start, user guide, and about PINNx, and removed the old example references.

@chaoming0625 chaoming0625 marked this pull request as ready for review December 13, 2024 11:40
@chaoming0625 chaoming0625 merged commit 28f1d10 into main Dec 13, 2024
12 checks passed
@chaoming0625 chaoming0625 deleted the fix-docs branch December 13, 2024 11:40
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.

2 participants