Consider Sphinx for Documentation

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

The issue names no files, tests, or entry points. Start by reviewing the repository's current documentation setup and evaluating Sphinx; done would require a decided documentation approach and an agreed implementation scope.

Written by the indexing model from the issue text.

Description

Consider using Sphinx (http://sphinx-doc.org/) for Documetnation purposes?

Dominant language
Python
Stars
29
Forks
17
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 azavea/python-sld

All issues in azavea/python-sld

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.