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

Integrate Trilinos documentation into Fortran code #80

Open
1 of 4 tasks
sethrj opened this issue Oct 16, 2017 · 2 comments
Open
1 of 4 tasks

Integrate Trilinos documentation into Fortran code #80

sethrj opened this issue Oct 16, 2017 · 2 comments

Comments

@sethrj
Copy link
Collaborator

sethrj commented Oct 16, 2017

  • Export Trilinos Doxygen as XML
  • Convert XML to SWIG .i file with doxy2swig
  • Modify .i file as needed
  • (in SWIG fortran) add support for %feature("autodoc")
@aprokop
Copy link
Collaborator

aprokop commented Nov 28, 2017

The way PyTrilinos currently works:

  • In $PYTRILINOS_DIR/CMakeLists.txt it configures PyTrilinos_DOCSTRINGS (there are a few errors in it, though)
  • In $PYTRILINOS_DIR/docs/Doxygen it a) generates helpers scripts from .in files using CONFIGURE_FILE command; b) Runs Doxygen for the specified packages to produce XML files; c) Runs doxy2swig file on those XML files to produce .i files with docstrings (which are stored in the binary directory/docs/Doxygen
  • In $PYTRILINOS_DIR/src it a) includes that Doxygen binary directory; b) Add -I option to running swig so that it can pick up those files; and c) manually includes the docs files (*_dox.i) into the proper package files (like Epetra.i).

@aprokop
Copy link
Collaborator

aprokop commented Nov 28, 2017

We need to copy this machinery from PyTrilinos, updated with a more recent version of doxy2swig (including @mattbement 's changes to include meta-data) and put it in ForTrilinos.

@aprokop aprokop removed this from the FY18Q1 milestone Dec 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants