Skip to content

Documentation #1863

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

Merged
merged 5 commits into from
Sep 26, 2022
Merged

Documentation #1863

merged 5 commits into from
Sep 26, 2022

Conversation

filmor
Copy link
Member

@filmor filmor commented Jul 8, 2022

What does this implement/fix? Explain your changes.

Adds Sphinx documentation using doxygen and breathe.

Does this close any currently open issues?

Among general documentation, will include #1406

TODO:

  • Implement doyxgen/breathe/sphinx setup
  • Update the included Embedding documentation to reflect the current state (esp. regarding installation)
  • Ensure that the (Python) code examples still work (i.e. make them doctests)
  • Separate installation documentation from the embedding sections, update and maybe add distribution-specific instructions (Add Archlinux Dependencies #1625).
  • Add Python reference and link clr-loader documentation (intersphinx)

@filmor filmor mentioned this pull request Jul 8, 2022
23 tasks
@filmor filmor force-pushed the docs branch 3 times, most recently from 2f070ff to 0e0b0fb Compare July 11, 2022 20:08
@filmor filmor force-pushed the docs branch 7 times, most recently from 4d1ab1c to e97de39 Compare September 17, 2022 13:56
@filmor filmor marked this pull request as ready for review September 26, 2022 00:25
@filmor filmor merged commit 80adda9 into pythonnet:release Sep 26, 2022
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