Not friendly to Windows users

Open
#4 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the existing Sphinx setup material and setup.py in the source folder. Document where Windows users can find Sphinx scripts and executables, how to set the %SPHINXBUILD% environment variable, and how to install Sphinx with python.exe setup.py install. Done means a newcomer can follow the Windows setup guidance without guessing.

Written by the indexing model from the issue text.

Description

I get to the repo to learn how to use Sphinx, but I find it really not that easy for Windows users.
1st, I shall look for the Sphinx scripts & exes(like sphinx-quickstart.exe);
2nd, I shall set the %SPHINXBUILD% env-var(no tip in the material).
And there's no tips for the new comers telling how to setup the Sphinx on Windows, though it's easy to type: 'python.exe setup.py install' under the source folder.

Dominant language
CSS
Stars
43
Forks
89
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 matplotlib/sampledoc

All issues in matplotlib/sampledoc

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.