Consider deploying sphinx for autodocs

Open
#286 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reviewing the project's current documentation, Python docstrings, and documentation publishing setup; no specific files or tests are named in the issue. Determine whether adopting Sphinx and enforcing reST docstrings are both in scope. Done means a defined Sphinx-based autodoc workflow is published and the required docstring conventions are documented or applied.

Written by the indexing model from the issue text.

Description

enhancement

Sphinx provides great utilities for auto-generating docs for code based on docstrings. We should consider utilizing it and publishing our docs using it. Note that to get the most out of it we would need to enforce reST style docstrings on all classes, modules, functions and class/instance attributes.

Dominant language
Python
Stars
139
Forks
52
Avg merge
1h 16m
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from splunk/contentctl

All issues in splunk/contentctl

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.