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 inline documentation #1

Open
Arian-D opened this issue Feb 25, 2021 · 3 comments
Open

Generate inline documentation #1

Arian-D opened this issue Feb 25, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Arian-D
Copy link
Collaborator

Arian-D commented Feb 25, 2021

Use sphinx to get inline documentation.

@Arian-D Arian-D added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 25, 2021
@Arian-D
Copy link
Collaborator Author

Arian-D commented Feb 26, 2021

Sphinx can now generate documentation from README.md and TODO.md. From e2d7b2a it can also generate inline code, but some of the stuff need to be explicit, and Bishoy's winrt calls might need to be documented.
clippy-server.pdf. is a demo of what it looks like, and it needs to be done better.

@alicebalayan will most likely have to see how to structure this and add a better theme.

@Arian-D
Copy link
Collaborator Author

Arian-D commented Feb 26, 2021

There is a package to add type hints to the docs. I'll have to add that too

@Arian-D
Copy link
Collaborator Author

Arian-D commented Feb 27, 2021

@alicebalayan https://sphinxthemes.com/ has a bunch. Let me know which one you like more here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants