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

Use Epytext for our inline documentation. #208

Open
seisatsu opened this issue Feb 7, 2018 · 3 comments
Open

Use Epytext for our inline documentation. #208

seisatsu opened this issue Feb 7, 2018 · 3 comments
Labels
investigate style

Comments

@seisatsu
Copy link
Member

seisatsu commented Feb 7, 2018

DAUX does not support generating API documentation. For this we should edit our comments to be compatible with a standalone API documentation generator project like pydoctor. Then link the API documentation from our manual as the API Reference chapter.
@seisatsu seisatsu added the style label Feb 7, 2018
@seisatsu
Copy link
Member Author

Specifically, this is the format to be employed for inline documentation. http://epydoc.sourceforge.net/epytext.html

@seisatsu seisatsu changed the title Make our inline documentation compatible with a documentation generator. Use Epytext for our inline documentation. Feb 11, 2018
@seisatsu
Copy link
Member Author

Nevermind, Pydoctor doesn't work on Python 3. I will find an alternative, probably that uses Epytext anyway.

@seisatsu
Copy link
Member Author

May want to return to sphinx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
investigate style
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@seisatsu