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

Created cmake module to generate module docs #253

Merged
merged 1 commit into from
May 27, 2022

Conversation

zachcran
Copy link
Contributor

Status

  • Ready to go

Description

This PR is a second attempt at PR #252 without the excessive commits and file history. It completes and is based on PR #206, creating some CMake infrastructure for automatically generating module documentation. This is intended to be used as part of the CI documentation website generation.

As part of the documentation, I included an example of how to use the planned API in a CMake project and how to generate the subsequent documentation website using Sphinx, even if it is not the top-level documentation.

TODOs

  • Fix the directory setup from erasing the executable in the process.
  • Test for ways to build the documentation when not top-level documentation with Sphinx.
    • (Found a way to do it) Document the process.
  • Finish documenting the CMake module using CMinx.
    • Verify that the documentation builds and looks alright.
  • Better generated module 'index.rst' files, issue Better generated index.rst #205. I think this should be its own PR separate from the CMake work.

@zachcran zachcran requested a review from ryanmrichard May 26, 2022 21:23
@zachcran zachcran marked this pull request as ready for review May 26, 2022 21:36
@ryanmrichard ryanmrichard merged commit b58ad13 into NWChemEx:master May 27, 2022
@zachcran zachcran deleted the cmake_module_doc_generation branch May 27, 2022 02:11
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