wagtail / sphinx-wagtail-theme

Wagtail's documentation theme for Sphinx
https://sphinx-wagtail-theme.readthedocs.io/
MIT License
30 stars 29 forks source link

Getting started guide not clear #292

Closed songproducer closed 1 month ago

songproducer commented 1 month ago

As a beginner in Wagtail, the usage instructions

Select the “Sphinx Wagtail theme” in the conf.py file of a Sphinx project:

is confusing. How do I add this to Wagtail?

laymonage commented 1 month ago

Hi @songproducer, this package is a theme for Sphinx the documentation tool (https://www.sphinx-doc.org/en/master/). It's not something you would normally add to a Wagtail project itself.

Do you use Sphinx to build the documentation of your project?

songproducer commented 1 month ago

Hi @laymonage It seems I misunderstood the purpose of Sphinx. I thought it was a general purpose theming tool for Wagtail.