pymc-labs/CausalPy

Improve docs through increased use of intersphinx

Open

#236 opened on Sep 11, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (111 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,162 stars)
PR merge metrics
 (PR metrics pending)

Description

  1. Add more intersphinx mappings in conf.py: 
    "pandas": ("https://pandas.pydata.org/docs/", None),
"scikit-learn": ("https://scikit-learn.org/stable/", None),
    And also arviz when referring to idata for example.
  2. Use external intersphinx references when referring to external classes/functions. E.g. https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#role-external

Contributor guide

Research direction
Add intersphinx mappings in conf.py as shown in the issue, and use external references in the documentation. Refer to the Sphinx intersphinx documentation for guidance.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85