Improve docs through increased use of intersphinx

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
pandas, python, scikit-learn
Domain
documentation

Research direction

Start in conf.py to review the existing intersphinx mappings, then inspect documentation references to external classes and functions, including the idata example. Use the Sphinx intersphinx external-role guidance linked in the issue, and consider the work done when relevant external references resolve through the added mappings.

Written by the indexing model from the issue text.

Description

documentation good first issue
  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
Dominant language
Python
Stars
1.2k
Forks
115
Avg merge
6d 1h
Merged PRs (30d)
11

Contributor guide

Open the contributing guide

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 pymc-labs/CausalPy

All issues in pymc-labs/CausalPy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.