Also provide the EPUB and PDF versions of the documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 327
- Forks
- 653
- PR merge metrics
- No merged PRs in 30d
Description
- Syncthing has quite some documentation.
- The used Sphinx documentation generator can generate EPUB and PDF also and offer it for download, which I would like to use to read the documentation more comfortably.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Sphinx documentation build configuration and the process that publishes the documentation site. Confirm how EPUB and PDF outputs can be generated and where downloadable artifacts should appear; done means both formats are built and available to documentation readers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100