mozilla-releng / mozilla-releng/relengdocs

Re-instate :caption: when supported by rtd.org

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

Nobody has claimed this yet.

Dominant language
Python
Stars
10
Forks
25
Avg merge
2d 17h
Merged PRs (30d)
2

Description

Graphviz captions were disabled in @64bf728 as a workaround to #5. Once readthedocs.org has the fixed version of sphinx deployed, we can revert that workaround.

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.

Research direction

Start by reviewing commit 64bf728 and issue #5 to identify the Graphviz caption workaround. Confirm that readthedocs.org has deployed the fixed Sphinx version, then verify that reverting the workaround restores :caption: support in the documentation build.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.