Skip to content

Code Documentation Base Template #98

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
Open
Pawel024 wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Code Documentation Base Template #98

Pawel024 wants to merge 8 commits into from

Conversation

@Pawel024
Copy link
Collaborator

@Pawel024 Pawel024 commented Feb 8, 2026 •
edited
Loading

This pull request sets up the base code documentation infrastructure:

  • Added Doxygen configuration for extracting API docs from source code
  • Added Sphinx + Breathe configuration to process and build the Doxygen output into a clean documentation with the ReadTheDocs theme
  • Populated 2 example module index pages (fem.rst, geometry.rst) and formatted comments/docstrings for FunctionSpace and FemField so that they are rendered in the docs
  • Added a README describing what we use for documentation

@Pawel024 Pawel024 marked this pull request as ready for review February 9, 2026 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Pawel024