Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add Documentation Site #34

Merged
merged 15 commits into from
Jul 10, 2023
Merged

Add Documentation Site #34

merged 15 commits into from
Jul 10, 2023

Conversation

threeal
Copy link
Owner

@threeal threeal commented Jul 10, 2023

  • Implemented the add_xml_docs CMake function to facilitate the generation of XML API documentation from the project's source code.
  • Initialized the Sphinx project to enable the generation of comprehensive documentation.
    • Integrated Breathe to map the project's API to Sphinx.
  • Added a configuration for Read the Docs, allowing the hosting of the project's documentation on that platform.
  • Closes Documentation Site Integration #12.

@threeal threeal self-assigned this Jul 10, 2023
@threeal threeal force-pushed the add-documentation branch from 89a929c to 1e4ac70 Compare July 10, 2023 05:31
@threeal threeal force-pushed the add-documentation branch from 2ee330e to bee807a Compare July 10, 2023 06:23
@threeal threeal changed the title Add Documentation Add Documentation Site Jul 10, 2023
@threeal threeal force-pushed the add-documentation branch from 4fe0793 to 067862f Compare July 10, 2023 07:05
@threeal threeal marked this pull request as ready for review July 10, 2023 08:43
@threeal threeal merged commit 7a5902b into main Jul 10, 2023
@threeal threeal deleted the add-documentation branch July 10, 2023 08:43
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Site Integration
1 participant