Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in / Register
  • funkwhale funkwhale
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 379
    • Issues 379
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 15
    • Merge requests 15
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • funkwhalefunkwhale
  • funkwhalefunkwhale
  • Merge requests
  • !1773

Draft: add manage.py to autodoc path

  • Review changes

  • Download
  • Email patches
  • Plain diff
Closed Ciarán Ainsworth requested to merge manage-py-reference into develop Apr 26, 2022
  • Overview 1
  • Commits 1
  • Pipelines 2
  • Changes 2

I'm trying to add manage.py to the conf.py path so that we can document all of its methods in a reference doc. These commands all seem to be installed in the api/funkwhale_api/cli folder, but when I try to add this as a path it just returns:

WARNING: autodoc: failed to import method 'users.create' from module 'cli'; the following exception was raised:
No module named 'cli'

The aim is to be able to create method documentation using the .. automethod:: function. This way we can keep everything up-to-date with changes to the script.

Edited Apr 26, 2022 by Ciarán Ainsworth
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: manage-py-reference