Skip to content

Render API documentation of Python bindings on website #239

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

Open
uekerman opened this issue Jan 20, 2023 · 2 comments
Open

Render API documentation of Python bindings on website #239

uekerman opened this issue Jan 20, 2023 · 2 comments
Labels
technical Technical issues on the website
Milestone

Comments

@uekerman
Copy link
Member

The Python bindings are one of the most important ways how users work with preCICE. We spent quite some time to write nice docstrings for the bindings. I would be good if we could integrate this documentation on the website as well. Ideally in such a way that also our search engine sees them.

Maybe a solution could be to first convert them into markdown (maybe via docutils or sphinx, I did not do much research yet) and then include in Jekyll.

Alternatively, we also directly generate html via sphinx, but this is probably not what we want.

@uekerman uekerman added the technical Technical issues on the website label Jan 20, 2023
@MakisH
Copy link
Member

MakisH commented Feb 12, 2023

Would be a solution for #165

@BenjaminRodenberg BenjaminRodenberg added this to the Version 3.x.x milestone Nov 11, 2023
@MakisH
Copy link
Member

MakisH commented Apr 29, 2024

Discussion:

  • We should do this before somebody else does it
  • We could use Sphinx
  • We could even use Doxygen
  • We could even manually convert it to Markdown and put it on the website (not ideal)
  • Important in any case would be to clearly link to the actual website
  • We could also link the "couple your code" for examples.
  • We don't want to make the "noise" searchable, just the API. See Include doxygen Participant page into search index #395.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical Technical issues on the website
Projects
Status: Mid
Development

No branches or pull requests

3 participants