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

Create a short ForTrilinos User's Guide #159

Open
aprokop opened this issue Dec 15, 2017 · 8 comments
Open

Create a short ForTrilinos User's Guide #159

aprokop opened this issue Dec 15, 2017 · 8 comments

Comments

@aprokop
Copy link
Collaborator

aprokop commented Dec 15, 2017

The content could be:

  • Installation
    • Take installation instructions from existing RTD
    • Talk about spack option (btw, this will have to be updated)
  • Brief overview and the general gist
    • Try to steer users to the existing Trilinos documentation
    • Highlight the differences (like native Fortran arrays, and few functions with different semantics)
  • Provide few examples
    • Could use existing power method example
  • Talk a bit about performance
@aprokop aprokop added this to the FY18Q1 milestone Dec 15, 2017
@aprokop
Copy link
Collaborator Author

aprokop commented Dec 15, 2017

The same text can be used in the guide and ReadTheDocs. The guide would simply server as something static and citable.

@tjfulle
Copy link
Collaborator

tjfulle commented Dec 15, 2017

Do we need both the RTD and a guide? Can we just run the RTD through a latex generator and create a PDF?

@aprokop
Copy link
Collaborator Author

aprokop commented Dec 15, 2017

Yep, could probably do that. RTD already generates the pdf. The main differences would be:
a) The report would be in report style (like Sandia report, or ORNL report)
b) We would like to maybe start with something published (so that it could go to OSTI), and then maintain a live version through RTD.

@tjfulle
Copy link
Collaborator

tjfulle commented Dec 15, 2017

Sounds good to me. That is what I am doing with the Tpetra documentation. It takes about 25 minutes to hand massage the sphinx generated LaTeX to play nice with the SANDReport classes, but it beats maintaining two versions.

@aprokop
Copy link
Collaborator Author

aprokop commented Dec 15, 2017

Is this something a python script could fix?

@tjfulle
Copy link
Collaborator

tjfulle commented Dec 15, 2017

I'm the type that views every problem as a nail and python as Thor's magic hammer to smash it, but I haven't found a good way to consistently make the changes required using python. They're pretty pervasive - changing the class, modifying some of the colors that clash with SANDReport, fixing equations and tables, etc.

@aprokop aprokop removed this from the FY18Q1 milestone Dec 19, 2017
@aprokop
Copy link
Collaborator Author

aprokop commented Mar 2, 2018

Would still like this to be done, but may need to postpone for now.

@sethrj sethrj mentioned this issue Feb 5, 2019
3 tasks
@kruger
Copy link
Contributor

kruger commented Sep 19, 2019

I don't know the requirements on sphinx extensions (adventurous? limited?) but what about this extension:
https://sphinx-fortran.readthedocs.io/en/latest/

Combined with the new tests?

Perhaps even more far-fetched would be to use this sphinx extension:
https://sphinxcontrib-osexample.readthedocs.io/en/latest/

to allow the native trilinos documentation to show C++ (default), fortran, and python. That would be slick.

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