stan-dev / stan-dev/docs

script `build.py` - improve handling/reporting build.py

Open
#219 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TeX
Stars
43
Forks
133
Avg merge
11h 32m
Merged PRs (30d)
4

Description

Summary:

The build.py script doesn't have enough error handling.
Improve both error handling in script, and provide more info on troubleshooting
in repo README and wikil.

Description:

see discourse: https://discourse.mc-stan.org/t/error-compiling-docs-using-build-py/16526

Additional Information:

Provide any additional information here.

Current Version:

v2.18.0

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.

Research direction

Start with build.py and read the linked Discourse discussion about errors compiling the docs, then inspect the repository README and wiki. Done means build failures are handled and reported more usefully, with corresponding troubleshooting guidance added to the README and wiki.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.