| Message ID | 20250214075146.85101-1-avri.altman@wdc.com |
|---|---|
| State | New |
| Headers | show |
| Series | [v2] mmc-utils: Docs: Fix Sphinx build error | expand |
Ping. Thanks, Avri > This patch fixes a Sphinx build error encountered during the > `make html-docs` process. Apparently the _static directory was absent > and the master document not being set in the Sphinx configuration. > > Fixes: 1d1b1159ce7a ("mmc-utils: Add documentation section") > Signed-off-by: Avri Altman <avri.altman@wdc.com> > > --- > Changes in v2: > - Add a fixes tag > --- > docs/_static/.gitkeep | 0 > docs/conf.py | 2 ++ > 2 files changed, 2 insertions(+) > create mode 100644 docs/_static/.gitkeep > > diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep > new file mode 100644 > index 0000000..e69de29 > diff --git a/docs/conf.py b/docs/conf.py > index 9c08a23..9bc69ce 100644 > --- a/docs/conf.py > +++ b/docs/conf.py > @@ -39,6 +39,8 @@ templates_path = ['_templates'] > # This pattern also affects html_static_path and html_extra_path. > exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] > > +# The master toctree document. > +master_doc = 'index' > > # -- Options for HTML output ------------------------------------------------- > > -- > 2.25.1
On Fri, 14 Feb 2025 at 08:54, Avri Altman <avri.altman@wdc.com> wrote: > > This patch fixes a Sphinx build error encountered during the > `make html-docs` process. Apparently the _static directory was absent > and the master document not being set in the Sphinx configuration. > > Fixes: 1d1b1159ce7a ("mmc-utils: Add documentation section") > Signed-off-by: Avri Altman <avri.altman@wdc.com> Applied to mmc-utils, thanks! Kind regards Uffe > > --- > Changes in v2: > - Add a fixes tag > --- > docs/_static/.gitkeep | 0 > docs/conf.py | 2 ++ > 2 files changed, 2 insertions(+) > create mode 100644 docs/_static/.gitkeep > > diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep > new file mode 100644 > index 0000000..e69de29 > diff --git a/docs/conf.py b/docs/conf.py > index 9c08a23..9bc69ce 100644 > --- a/docs/conf.py > +++ b/docs/conf.py > @@ -39,6 +39,8 @@ templates_path = ['_templates'] > # This pattern also affects html_static_path and html_extra_path. > exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] > > +# The master toctree document. > +master_doc = 'index' > > # -- Options for HTML output ------------------------------------------------- > > -- > 2.25.1 >
diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/conf.py b/docs/conf.py index 9c08a23..9bc69ce 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,6 +39,8 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +# The master toctree document. +master_doc = 'index' # -- Options for HTML output -------------------------------------------------
This patch fixes a Sphinx build error encountered during the `make html-docs` process. Apparently the _static directory was absent and the master document not being set in the Sphinx configuration. Fixes: 1d1b1159ce7a ("mmc-utils: Add documentation section") Signed-off-by: Avri Altman <avri.altman@wdc.com> --- Changes in v2: - Add a fixes tag --- docs/_static/.gitkeep | 0 docs/conf.py | 2 ++ 2 files changed, 2 insertions(+) create mode 100644 docs/_static/.gitkeep