Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • bob.extension bob.extension
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 5
    • Issues 5
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • bobbob
  • bob.extensionbob.extension
  • Issues
  • #28
Closed
Open
Issue created Sep 28, 2016 by André Anjos@andre.anjos💬Owner

Automatic docstring generator should adopt one of "Napoleon" styles

When we wrote our documentation generator in documentation.h, there was not a set standard for documenting functions in sphinx. Since release 1.3 (which is now required by most of our software), there is:

http://www.sphinx-doc.org/en/stable/ext/napoleon.html

The napoleon extension is already loaded by most of our software, so it makes sense that the generator follows one of the docstring standards defined on that manual page. Some of our python-based docstrings already follow the "Google" style:

http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google

It would be good to get the C++ docs matching that.

Assignee
Assign to
Time tracking