Create a template for docs/conf.py

Open
#100 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by locating existing docs/conf.py and docs/src/conf.py files in the relevant repositories and compare their required contents. Define what the shared template must include and where it should live; done means the template is available in the expected path and can support the documented repository layouts.

Written by the indexing model from the issue text.

Description

Note that in some repos, this is found in docs/src/conf.py (looking at you, Iris).

Dominant language
Python
Stars
3
Forks
7
PR merge metrics
No merged PRs in 30d

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 SciTools/.github

All issues in SciTools/.github

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.