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

Generate Module Documentation From Module Manager #144

Closed
ryanmrichard opened this issue Nov 16, 2020 · 4 comments
Closed

Generate Module Documentation From Module Manager #144

ryanmrichard opened this issue Nov 16, 2020 · 4 comments

Comments

@ryanmrichard
Copy link
Member

Each supermodule includes a function load_modules(sde::ModuleManager&) From Python, it should be easy to write a script that does something like:

mm = ModuleManager()
sm.load_modules(mm) # sm is the supermodule, i.e. integrals, SCF, MP2, etc.
for key, mod in mm:
    desc = sde.document_module(key, mod)
     # print desc to file

Ideally it should be one module per page and the Python script should also generate an index.rst for the created pages.

@ryanmrichard
Copy link
Member Author

@zachcran IIRC you wrote a C++ version of this right?

@zachcran
Copy link
Contributor

zachcran commented Feb 15, 2022

Yes, I believe so. I either helped with src/pluginplay/printing/document_module.cpp, src/pluginplay/printing/document_modules.cpp, or some other combination of the printing functions, but I can't remember and the files don't have their history from before the rename.

There is also a PR (#206) in the works that I hope to finish soon that will generate an executable to create the documentation.

Edit: Sorry I was two weeks late to reply! I somehow missed the notification for this one!

@twindus
Copy link
Contributor

twindus commented Feb 15, 2022

@ryanmrichard and @zachcran I assume that we don't need a Python version, so is this good to close?

@zachcran
Copy link
Contributor

I think so, since the documentation should be generated as part of the CI after I finish PR #206. I'll leave the choice to @ryanmrichard, though.

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

No branches or pull requests

3 participants