Further instruction needed

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

Nobody has claimed this yet.

Assessment

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

Research direction

Open the lesson at /en/projects/documenting-your-code/6 and read its Sphinx 3.4.2 Quickstart instructions, then inspect the referenced config.py setup. Done means the quickstart explains that Autodoc must be activated and shows the required extensions setting.

Written by the indexing model from the issue text.

Description

medium project Python

URL: /en/projects/documenting-your-code/6

Project "Documenting your Code".
Sphynx 3.4.2 Quickstart doesn't ask to activate Autodoc. It has to be manually activated in the config.py file by adding extensions = ['sphinx.ext.autodoc'].

Dominant language
Python
Stars
4
Forks
1
PR merge metrics
No merged PRs in 30d

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.

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.