Create required dirs

[DanRoscigno]

Add prerequisites for make sp-run

When I run make run I get two errors, missing _build dir and missing .doctrees dir.

I have gotten into the habit of running make html first and then make run, but having the dirs as prereqs for make run seems more appropriate.

[SecondSkoll]

As per #276 this is an issue with an upstream package, sphinx-autobuild. It is recommended to just run make html before make run. Your solution would fail if the directories already exist. A better solution would be to pin to the 2024.04.16 release of sphinx-autobuild until the issue is fixed.

Additionally, there is currently a PR open in that project to fix the issue.

[DanRoscigno]

As per #276 this is an issue with an upstream package, sphinx-autobuild. It is recommended to just run make html before make run. Your solution would fail if the directories already exist. A better solution would be to pin to the 2024.04.16 release of sphinx-autobuild until the issue is fixed.

Additionally, there is currently a PR open in that project to fix the issue.

The -p prevents an error if the dir already exists, just like on this line:

sphinx-docs-starter-pack/Makefile.sp

Line 72 in 5bd65aa

mkdir -p $(SPHINXDIR)/node_modules/ ; \

But, I will close it and use the workaround.

[SecondSkoll]

As per #276 this is an issue with an upstream package, sphinx-autobuild. It is recommended to just run make html before make run. Your solution would fail if the directories already exist. A better solution would be to pin to the 2024.04.16 release of sphinx-autobuild until the issue is fixed.
Additionally, there is currently a PR open in that project to fix the issue.

The -p prevents an error if the dir already exists, just like on this line:

sphinx-docs-starter-pack/Makefile.sp

Line 72 in 5bd65aa

mkdir -p $(SPHINXDIR)/node_modules/ ; \

But, I will close it and use the workaround.

Of course it does, sorry! I was not paying enough attention.
I'll try and move that upstream PR along as much as I can. :)

[DanRoscigno]

As per #276 this is an issue with an upstream package, sphinx-autobuild. It is recommended to just run make html before make run. Your solution would fail if the directories already exist. A better solution would be to pin to the 2024.04.16 release of sphinx-autobuild until the issue is fixed.
Additionally, there is currently a PR open in that project to fix the issue.

The -p prevents an error if the dir already exists, just like on this line:

sphinx-docs-starter-pack/Makefile.sp

Line 72 in 5bd65aa

mkdir -p $(SPHINXDIR)/node_modules/ ; \

But, I will close it and use the workaround.

Of course it does, sorry! I was not paying enough attention. I'll try and move that upstream PR along as much as I can. :)

No worries, I had to look up the flag to make sure that it was portable across operating systems. I will use make html in the guide I am writing since it makes sense for new writers to understand the workflow.

[SecondSkoll]

That's a good idea. I saw your CODA issue and that will be really helpful. Just be aware there will be some significant changes to the starter pack soon, as we'll be moving to the use-canonical-sphinx-extension branch, which requires less configuration.

Though I think I'll pin everything and tag this main branch before we move to that version, so that there'll be a permanent version of this iteration of the starter pack here (and hopefully the autobuild issue will be resolved by then).

[DanRoscigno]

Cheers, I like the workflow described in that branch. I will try that out now!