sphinx-notes / sphinx-notes/pages
Use makefile instead of calling build-sphinx ?
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 100
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
Users may have customised their makefile to include additional steps while building the html, but these are then lost when using because instead of calling
make html
it calls
sphinx-build -b html "$doc_dir" "$tmp_dir" $INPUT_SPHINX_OPTIONS
Is there any reason not to call like this?
make html BUILDDIR="$tmp_dir" SPHINXOPTS="$INPUT_SPHINX_OPTIONS"
which would, I think, achieve the same.
The only change later in main.sh would be
rm -rf $tmp_dir/.doctrees
cp -vr $tmp_dir/. $INPUT_TARGET_PATH
becomes
rm -rf $tmp_dir/html/.doctrees
cp -vr $tmp_dir/html/. $INPUT_TARGET_PATH
because make by default will add /html for that build
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 reading main.sh and the project's Makefile, then compare the current sphinx-build invocation with the proposed make html command and its output directory. Verify that customized Makefile steps are honored and that the generated HTML is still copied to the target path; the issue's requested behavior is complete when both build and copy paths work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, shell
- Domain
- build-system, ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100