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.

Sign up for GitHub

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

Jump to bottom

[Feature Request] Create Documentation for Echo #34

Open
ClemensU42 opened this issue Jun 28, 2022 · 4 comments
Open

[Feature Request] Create Documentation for Echo #34

ClemensU42 opened this issue Jun 28, 2022 · 4 comments
Assignees
@ClemensU42
Labels
big change Requires any big restructuring or rewriting. documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Release 1.0.0

Comments

@ClemensU42
Copy link
Collaborator

No description provided.

@ClemensU42 ClemensU42 added documentation Improvements or additions to documentation enhancement New feature or request big change Requires any big restructuring or rewriting. labels Jun 28, 2022
@ClemensU42 ClemensU42 added this to the Release 1.0.0 milestone Jun 28, 2022
@ClemensU42
Copy link
Collaborator Author

@GaryHuan9 what do you think about using Doxygen for documentation?

@GaryHuan9
Copy link
Owner

Okay so your comment led me to some more digging. Originally, I was thinking about using readthedocs.org, but I have never heard of Doxygen before. I briefly looked at its website and I think we can definitely use it for our Echo.Core code API. Now it looks like our best option is to use GitHub pages and Sphinx to generate the documentation for using Echo actually as a renderer (rather than a code API). It would be the best if we can also put Doxygen into Sphinx.

@ClemensU42
Copy link
Collaborator Author

Here's a link to Breathe, a tool that enables you to use both Sphinx and Doxygen: https://breathe.readthedocs.io/en/latest/

@GaryHuan9
Copy link
Owner

That looks good, we can definitely use it when we create our documentation.

@ClemensU42 ClemensU42 self-assigned this Dec 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ClemensU42 ClemensU42

Labels
big change Requires any big restructuring or rewriting. documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
Release 1.0.0
Development

When branches are created from issues, their pull requests are automatically linked.

34-feature-request-create-documentation-for-echo GaryHuan9/Echo
2 participants
@GaryHuan9 @ClemensU42