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

Feature: generate sphinx documentation #9

Open
3 of 11 tasks
ronaldoussoren opened this issue Aug 26, 2020 · 0 comments
Open
3 of 11 tasks

Feature: generate sphinx documentation #9

ronaldoussoren opened this issue Aug 26, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@ronaldoussoren
Copy link
Owner

I'm working on a "docgen" subcommand that will generate sphinx documentation.

  • Add "docgen" subcommand
  • Document "enum" values and types
  • Document "externs" values and types
  • Document classes and methods (mostly done, but can be better)
  • Document functions
  • Document aliases
  • Document expressions
  • Document literals
  • Implement a mechanism to add introduction text to the file (pre-amble)
  • Implement a mechanism to document additional methods (such as convenience methods, but also custom __new__)
  • Cross-module references need work
@ronaldoussoren ronaldoussoren added the enhancement New feature or request label Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant