Skip to content

Sphinx workflow using the starter pack #123

@DanRoscigno

Description

@DanRoscigno

I was following the getting started instructions for sphinx and ran into an issue with the Makefile.

The instructions seem to assume that the Starter Pack is installed, but only the sphinx package is installed, so there is no Makefile.

I am happy to write a PR to fix this, but I wanted to check with you to see what the desired workflow is. I would think that you would want a workflow something like:

  • clone the starter pack
  • cd into the starter pack
  • build and server the starter pack samples
  • copy some of the .rst or .md files from the multipass, snapcraft, or wsl folders from the open-documentation-academy repo into the starter pack folder
  • add the new folder(s) to index.rst
  • make build and examine the structure under the build folder
  • make serve

Does this sound correct?

Metadata

Metadata

Assignees

Labels

size 2Fix a known documentation issue (size 2/8)updateUpdate potentially outdated instructions, commands, or version numbers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions