getodk / getodk/docs

Document `incl` folder and including partial docs in other docs

Open
#550 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

partial docs can go in `incl`

included in another doc with:

```

.. include:: incl/doc-name.rst

```

Contributor guide

Open the contributing guide

Research direction

Start by locating the `incl` folder in the Sphinx documentation source and inspect how existing documents are organized. Document that partial docs belong there and use the shown `.. include:: incl/doc-name.rst` syntax; done means readers can find and understand both conventions.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.