jacebrowning / jacebrowning/gitman
Source code is incorrectly shown in the documentation
Open
bug
help wanted
- Dominant language
- Python
- Stars
- 225
- Forks
- 36
- Avg merge
- 15h 47m
- Merged PRs (30d)
- 8
Description
This page should show the docstrings but not embed the source code: https://gitman.readthedocs.io/en/latest/setup/configuration/
It seems the `mkdocstrings` settings are being ignored.
Contributor guide
Research direction
Start with the configuration page at https://gitman.readthedocs.io/en/latest/setup/configuration/ and inspect the repository's mkdocstrings settings. Determine why the settings are ignored, then verify that the page shows docstrings without embedding source code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100