SatelliteQE/airgun

class internal references in documentation does not work

Open

#31 opened on Feb 28, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (83 forks)auto 404
enhancementgood first issuelow

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

There is this in docs/config.py and I was unable to make the documentation build work without it:

nitpick_ignore = [
    [...]
    ('py:meth', 'current_org')
    [...]

IMO it is just some omission somewhere. Found https://stackoverflow.com/questions/21289806/link-to-class-method-in-python-docstring, but that does not seem to help.

This is a follow up on this discussion: https://github.com/SatelliteQE/airgun/pull/22#discussion_r170548197

Contributor guide

Research direction
Investigate how to correctly reference class methods in Sphinx documentation. Check for missing Sphinx extensions (e.g., autodoc) or configuration issues with intersphinx.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65