PlasmaPy / PlasmaPy/PlasmaPy

Powershell script for building documenation

Open
#1,303 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
711
Forks
375
Avg merge
3h 2m
Merged PRs (30d)
8

Description

Currently there are three ways to build docuemnation locally...

  1. using the make scripts
  2. using tox
  3. typing out the raw commands python -m sphinx ...

tox is great for CI but annoying to local builds because it builds a python virtual environment. make is great for Linux and MacOS systems, but does not work well with Windows' command prompt and Powershell terminals. You can use the make command in the WSL terminal, but the building process is slow because the build files exist on the Windows file system and not the virtual Linux file system. One can run the basic build commands in Powershell, but it's a bit annoying trying to remember what the correct command is. I'm proposing to look into making a Powershell script that is analogous to the make script for Windows users.

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.

Research direction

Inspect the existing make scripts and tox configuration, then compare them with the documented python -m sphinx ... commands. Add a Windows PowerShell equivalent that builds the documentation locally; done means the documented build succeeds without relying on WSL or a newly created tox environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, python
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.