[maintainer-tools PATCH 0/5] add Sphinx doc build to maintainer tools

[maintainer-tools PATCH 0/5] add Sphinx doc build to maintainer tools

[Jani Nikula]

Make it possible to build the maintainer tools docs using Sphinx. For
now, support building using both rst2html and Sphinx. After all
consumers and autobuilders of the docs have switched over to Sphinx, we
can start improving the documentation to produce a more coherent and
unified set of maintainer tools documents.

BR,
Jani.


Jani Nikula (5):
  mancheck: run dim.rst through rst2man
  build: add drm-misc-commit-flow.svg to clean target
  doc: use window.onload to call WaveDrom.ProcessAll()
  doc: build documentation using Sphinx
  doc: use Sphinx bizstyle builtin html theme

 .gitignore             |   1 +
 Makefile               |  68 ++++++++++++--
 conf.py                | 236 +++++++++++++++++++++++++++++++++++++++++++++++++
 dim.rst                |   2 +
 drm-intel-timeline.rst |   4 +
 drm-misc-timeline.rst  |   4 +
 index.rst              |  17 ++++
 7 files changed, 324 insertions(+), 8 deletions(-)
 create mode 100644 conf.py
 create mode 100644 index.rst

-- 
2.11.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[maintainer-tools PATCH 1/5] mancheck: run dim.rst through rst2man

[Jani Nikula]

Be strict and also require plain rst with no raw directives.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 Makefile | 1 +
 dim.rst  | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/Makefile b/Makefile
index 44fcdc90473a..784d986b18cd 100644
--- a/Makefile
+++ b/Makefile
@@ -43,6 +43,7 @@ mancheck:
 			echo "$@: $$cmd not documented"; \
 		fi \
 	done
+	rst2man --strict --no-raw dim.rst >/dev/null
 
 check: shellcheck mancheck all
 
diff --git a/dim.rst b/dim.rst
index a2c110a054ee..8b4653aacbda 100644
--- a/dim.rst
+++ b/dim.rst
@@ -13,6 +13,8 @@ drm inglorious maintainer script
 :Manual section: 1
 :Manual group: maintainer tools
 
+.. Please use 'make mancheck' to validate updates to this file.
+
 SYNOPSIS
 ========
 
-- 
2.11.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 1/5] mancheck: run dim.rst through rst2man

[Rodrigo Vivi]

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
> Be strict and also require plain rst with no raw directives.
>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
>  Makefile | 1 +
>  dim.rst  | 2 ++
>  2 files changed, 3 insertions(+)
>
> diff --git a/Makefile b/Makefile
> index 44fcdc90473a..784d986b18cd 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -43,6 +43,7 @@ mancheck:
>                         echo "$@: $$cmd not documented"; \
>                 fi \
>         done
> +       rst2man --strict --no-raw dim.rst >/dev/null
>
>  check: shellcheck mancheck all
>
> diff --git a/dim.rst b/dim.rst
> index a2c110a054ee..8b4653aacbda 100644
> --- a/dim.rst
> +++ b/dim.rst
> @@ -13,6 +13,8 @@ drm inglorious maintainer script
>  :Manual section: 1
>  :Manual group: maintainer tools
>
> +.. Please use 'make mancheck' to validate updates to this file.
> +
>  SYNOPSIS
>  ========
>
> --
> 2.11.0
>
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx



-- 
Rodrigo Vivi
Blog: http://blog.vivi.eng.br
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[maintainer-tools PATCH 2/5] build: add drm-misc-commit-flow.svg to clean target

[Jani Nikula]

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 784d986b18cd..8bbabae56741 100644
--- a/Makefile
+++ b/Makefile
@@ -48,6 +48,6 @@ mancheck:
 check: shellcheck mancheck all
 
 clean:
-	rm -f drm-intel.html drm-intel-flow.svg dim.html drm-misc.html
+	rm -f drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html
 
 .PHONY: all clean
-- 
2.11.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 2/5] build: add drm-misc-commit-flow.svg to clean target

[Rodrigo Vivi]

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
>  Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 784d986b18cd..8bbabae56741 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -48,6 +48,6 @@ mancheck:
>  check: shellcheck mancheck all
>
>  clean:
> -       rm -f drm-intel.html drm-intel-flow.svg dim.html drm-misc.html
> +       rm -f drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html
>
>  .PHONY: all clean
> --
> 2.11.0
>
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx



-- 
Rodrigo Vivi
Blog: http://blog.vivi.eng.br
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[maintainer-tools PATCH 3/5] doc: use window.onload to call WaveDrom.ProcessAll()

[Jani Nikula]

Simplify the build by doing the WaveDrom processing from the rst file
(albeit raw html block) instead of post-processing the output html.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 Makefile               | 6 ------
 drm-intel-timeline.rst | 4 ++++
 drm-misc-timeline.rst  | 4 ++++
 3 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/Makefile b/Makefile
index 8bbabae56741..7059eec42720 100644
--- a/Makefile
+++ b/Makefile
@@ -12,15 +12,9 @@ all: drm-intel.html dim.html drm-misc.html
 %.html: %.rst
 	rst2html $< > $@
 
-# the sed bit here is a hack to make wavedrom process the timeline
 drm-intel.html: drm-intel.rst drm-intel-flow.svg drm-intel-timeline.rst drm-intel-timeline.json
-	rst2html $< > $@
-	sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
 
-# the sed bit here is a hack to make wavedrom process the timeline
 drm-misc.html: drm-misc.rst drm-misc-timeline.rst drm-misc-timeline.json drm-misc-commit-flow.svg
-	rst2html $< > $@
-	sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
 
 dim.html: dim.rst
 
diff --git a/drm-intel-timeline.rst b/drm-intel-timeline.rst
index e1766a5df98b..3ab39afd5788 100644
--- a/drm-intel-timeline.rst
+++ b/drm-intel-timeline.rst
@@ -17,6 +17,10 @@
 
 .. raw:: html
 
+	function init() {
+		WaveDrom.ProcessAll();
+	}
+	window.onload = init;
 	</script>
 	<script type="WaveDrom">
 
diff --git a/drm-misc-timeline.rst b/drm-misc-timeline.rst
index 697277774362..a9a80d6a4cfb 100644
--- a/drm-misc-timeline.rst
+++ b/drm-misc-timeline.rst
@@ -8,6 +8,10 @@
 
 .. raw:: html
 
+	function init() {
+		WaveDrom.ProcessAll();
+	}
+	window.onload = init;
 	</script>
 	<script type="text/javascript">
 	/* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
-- 
2.11.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 3/5] doc: use window.onload to call WaveDrom.ProcessAll()

[Rodrigo Vivi]

I don't know WaveDrom much... but it works so

Acked-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
> Simplify the build by doing the WaveDrom processing from the rst file
> (albeit raw html block) instead of post-processing the output html.
>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
>  Makefile               | 6 ------
>  drm-intel-timeline.rst | 4 ++++
>  drm-misc-timeline.rst  | 4 ++++
>  3 files changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/Makefile b/Makefile
> index 8bbabae56741..7059eec42720 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -12,15 +12,9 @@ all: drm-intel.html dim.html drm-misc.html
>  %.html: %.rst
>         rst2html $< > $@
>
> -# the sed bit here is a hack to make wavedrom process the timeline
>  drm-intel.html: drm-intel.rst drm-intel-flow.svg drm-intel-timeline.rst drm-intel-timeline.json
> -       rst2html $< > $@
> -       sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
>
> -# the sed bit here is a hack to make wavedrom process the timeline
>  drm-misc.html: drm-misc.rst drm-misc-timeline.rst drm-misc-timeline.json drm-misc-commit-flow.svg
> -       rst2html $< > $@
> -       sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
>
>  dim.html: dim.rst
>
> diff --git a/drm-intel-timeline.rst b/drm-intel-timeline.rst
> index e1766a5df98b..3ab39afd5788 100644
> --- a/drm-intel-timeline.rst
> +++ b/drm-intel-timeline.rst
> @@ -17,6 +17,10 @@
>
>  .. raw:: html
>
> +       function init() {
> +               WaveDrom.ProcessAll();
> +       }
> +       window.onload = init;
>         </script>
>         <script type="WaveDrom">
>
> diff --git a/drm-misc-timeline.rst b/drm-misc-timeline.rst
> index 697277774362..a9a80d6a4cfb 100644
> --- a/drm-misc-timeline.rst
> +++ b/drm-misc-timeline.rst
> @@ -8,6 +8,10 @@
>
>  .. raw:: html
>
> +       function init() {
> +               WaveDrom.ProcessAll();
> +       }
> +       window.onload = init;
>         </script>
>         <script type="text/javascript">
>         /* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
> --
> 2.11.0
>
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx



-- 
Rodrigo Vivi
Blog: http://blog.vivi.eng.br
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 3/5] doc: use window.onload to call WaveDrom.ProcessAll()

[Jani Nikula]

On Thu, 10 Aug 2017, Rodrigo Vivi <rodrigo.vivi@gmail.com> wrote:
> I don't know WaveDrom much... but it works so
>
> Acked-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

Thanks, pushed the first three.

BR,
Jani.

>
> On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
>> Simplify the build by doing the WaveDrom processing from the rst file
>> (albeit raw html block) instead of post-processing the output html.
>>
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> ---
>>  Makefile               | 6 ------
>>  drm-intel-timeline.rst | 4 ++++
>>  drm-misc-timeline.rst  | 4 ++++
>>  3 files changed, 8 insertions(+), 6 deletions(-)
>>
>> diff --git a/Makefile b/Makefile
>> index 8bbabae56741..7059eec42720 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -12,15 +12,9 @@ all: drm-intel.html dim.html drm-misc.html
>>  %.html: %.rst
>>         rst2html $< > $@
>>
>> -# the sed bit here is a hack to make wavedrom process the timeline
>>  drm-intel.html: drm-intel.rst drm-intel-flow.svg drm-intel-timeline.rst drm-intel-timeline.json
>> -       rst2html $< > $@
>> -       sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
>>
>> -# the sed bit here is a hack to make wavedrom process the timeline
>>  drm-misc.html: drm-misc.rst drm-misc-timeline.rst drm-misc-timeline.json drm-misc-commit-flow.svg
>> -       rst2html $< > $@
>> -       sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
>>
>>  dim.html: dim.rst
>>
>> diff --git a/drm-intel-timeline.rst b/drm-intel-timeline.rst
>> index e1766a5df98b..3ab39afd5788 100644
>> --- a/drm-intel-timeline.rst
>> +++ b/drm-intel-timeline.rst
>> @@ -17,6 +17,10 @@
>>
>>  .. raw:: html
>>
>> +       function init() {
>> +               WaveDrom.ProcessAll();
>> +       }
>> +       window.onload = init;
>>         </script>
>>         <script type="WaveDrom">
>>
>> diff --git a/drm-misc-timeline.rst b/drm-misc-timeline.rst
>> index 697277774362..a9a80d6a4cfb 100644
>> --- a/drm-misc-timeline.rst
>> +++ b/drm-misc-timeline.rst
>> @@ -8,6 +8,10 @@
>>
>>  .. raw:: html
>>
>> +       function init() {
>> +               WaveDrom.ProcessAll();
>> +       }
>> +       window.onload = init;
>>         </script>
>>         <script type="text/javascript">
>>         /* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
>> --
>> 2.11.0
>>
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[maintainer-tools PATCH 4/5] doc: build documentation using Sphinx

[Jani Nikula]

Based on Sphinx-quickstart, with existing and generated Makefiles merged
together.

This makes the rst2html and Sphinx builds work side by side. Plain
'make' continues to use rst2html, and 'make html' and friends use
Sphinx. The intention is to keep both for a transition period so that we
can have documentation autobuilders updated.

Once we're fully converted to Sphinx, we can start looking into using
the graphviz (Sphinx builtin) and WaveDrom (3rd party) extensions. For
now, we use the same old clunky methods for including them.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 .gitignore |   1 +
 Makefile   |  61 +++++++++++++++-
 conf.py    | 236 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 index.rst  |  17 +++++
 4 files changed, 313 insertions(+), 2 deletions(-)
 create mode 100644 conf.py
 create mode 100644 index.rst

diff --git a/.gitignore b/.gitignore
index 35ed071ca482..a176bd76eef5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
+_build
 drm-intel-flow.svg
 drm-misc-commit-flow.svg
 *.html
diff --git a/Makefile b/Makefile
index 7059eec42720..40b7ee6e2b32 100644
--- a/Makefile
+++ b/Makefile
@@ -4,6 +4,20 @@
 # the wavedrom json, copy-pasting to and from http://wavedrom.com/editor.html is
 # handy as it shows the result live.
 
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: all
 all: drm-intel.html dim.html drm-misc.html
 
 %.svg: %.dot
@@ -41,7 +55,50 @@ mancheck:
 
 check: shellcheck mancheck all
 
+.PHONY: clean
 clean:
-	rm -f drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html
+	rm -rf drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html $(BUILDDIR)
+
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+# FIXME: This works for the first build, but not for updates. Look into using
+# Sphinx extensions for both the graphviz and wavedrom parts.
+html dirhtml singlehtml linkcheck doctest: drm-intel-flow.svg drm-misc-commit-flow.svg
+
+.PHONY: html
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: linkcheck
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
 
-.PHONY: all clean
+.PHONY: doctest
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/conf.py b/conf.py
new file mode 100644
index 000000000000..2e7acb8e76ca
--- /dev/null
+++ b/conf.py
@@ -0,0 +1,236 @@
+# -*- coding: utf-8 -*-
+#
+# DRM Maintainer Tools documentation build configuration file, created by
+# sphinx-quickstart on Wed Aug  9 17:57:16 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'DRM Maintainer Tools'
+copyright = u'2012-2017, Jani Nikula, Daniel Vetter, and others'
+author = u'Jani Nikula, Daniel Vetter'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+# html_title = u'DRM Maintainer Tools v1.0'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+# html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'DRMMaintainerToolsdoc'
diff --git a/index.rst b/index.rst
new file mode 100644
index 000000000000..d8b6d4897c45
--- /dev/null
+++ b/index.rst
@@ -0,0 +1,17 @@
+DRM Maintainer Tools
+====================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   drm-misc
+   drm-intel
+   dim
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
-- 
2.11.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 4/5] doc: build documentation using Sphinx

[Rodrigo Vivi]

On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
> Based on Sphinx-quickstart, with existing and generated Makefiles merged
> together.
>
> This makes the rst2html and Sphinx builds work side by side. Plain
> 'make' continues to use rst2html, and 'make html' and friends use
> Sphinx. The intention is to keep both for a transition period so that we
> can have documentation autobuilders updated.

the one that posts to 01.org or do we have more places pointing here?

>
> Once we're fully converted to Sphinx, we can start looking into using
> the graphviz (Sphinx builtin) and WaveDrom (3rd party) extensions. For
> now, we use the same old clunky methods for including them.

when we know we are fully converted?

>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
>  .gitignore |   1 +
>  Makefile   |  61 +++++++++++++++-
>  conf.py    | 236 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  index.rst  |  17 +++++
>  4 files changed, 313 insertions(+), 2 deletions(-)
>  create mode 100644 conf.py
>  create mode 100644 index.rst
>
> diff --git a/.gitignore b/.gitignore
> index 35ed071ca482..a176bd76eef5 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -1,3 +1,4 @@
> +_build
>  drm-intel-flow.svg
>  drm-misc-commit-flow.svg
>  *.html
> diff --git a/Makefile b/Makefile
> index 7059eec42720..40b7ee6e2b32 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -4,6 +4,20 @@
>  # the wavedrom json, copy-pasting to and from http://wavedrom.com/editor.html is
>  # handy as it shows the result live.
>
> +# You can set these variables from the command line.
> +SPHINXOPTS    =
> +SPHINXBUILD   = sphinx-build
> +PAPER         =
> +BUILDDIR      = _build
> +
> +# Internal variables.
> +PAPEROPT_a4     = -D latex_paper_size=a4
> +PAPEROPT_letter = -D latex_paper_size=letter
> +ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
> +# the i18n builder cannot share the environment and doctrees with the others
> +I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
> +
> +.PHONY: all
>  all: drm-intel.html dim.html drm-misc.html
>
>  %.svg: %.dot
> @@ -41,7 +55,50 @@ mancheck:
>
>  check: shellcheck mancheck all
>
> +.PHONY: clean
>  clean:
> -       rm -f drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html
> +       rm -rf drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html $(BUILDDIR)
> +
> +.PHONY: help
> +help:
> +       @echo "Please use \`make <target>' where <target> is one of"
> +       @echo "  html       to make standalone HTML files"
> +       @echo "  dirhtml    to make HTML files named index.html in directories"
> +       @echo "  singlehtml to make a single large HTML file"
> +       @echo "  linkcheck  to check all external links for integrity"
> +       @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
> +
> +# FIXME: This works for the first build, but not for updates. Look into using
> +# Sphinx extensions for both the graphviz and wavedrom parts.
> +html dirhtml singlehtml linkcheck doctest: drm-intel-flow.svg drm-misc-commit-flow.svg
> +
> +.PHONY: html
> +html:
> +       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
> +       @echo
> +       @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
> +
> +.PHONY: dirhtml
> +dirhtml:
> +       $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
> +       @echo
> +       @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
> +
> +.PHONY: singlehtml
> +singlehtml:
> +       $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
> +       @echo
> +       @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
> +
> +.PHONY: linkcheck
> +linkcheck:
> +       $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
> +       @echo
> +       @echo "Link check complete; look for any errors in the above output " \
> +             "or in $(BUILDDIR)/linkcheck/output.txt."
>
> -.PHONY: all clean
> +.PHONY: doctest
> +doctest:
> +       $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
> +       @echo "Testing of doctests in the sources finished, look at the " \
> +             "results in $(BUILDDIR)/doctest/output.txt."
> diff --git a/conf.py b/conf.py
> new file mode 100644
> index 000000000000..2e7acb8e76ca
> --- /dev/null
> +++ b/conf.py
> @@ -0,0 +1,236 @@
> +# -*- coding: utf-8 -*-
> +#
> +# DRM Maintainer Tools documentation build configuration file, created by
> +# sphinx-quickstart on Wed Aug  9 17:57:16 2017.
> +#
> +# This file is execfile()d with the current directory set to its
> +# containing dir.
> +#
> +# Note that not all possible configuration values are present in this
> +# autogenerated file.
> +#
> +# All configuration values have a default; values that are commented out
> +# serve to show the default.
> +
> +# If extensions (or modules to document with autodoc) are in another directory,
> +# add these directories to sys.path here. If the directory is relative to the
> +# documentation root, use os.path.abspath to make it absolute, like shown here.
> +#
> +# import os
> +# import sys
> +# sys.path.insert(0, os.path.abspath('.'))
> +
> +# -- General configuration ------------------------------------------------
> +
> +# If your documentation needs a minimal Sphinx version, state it here.
> +#
> +# needs_sphinx = '1.0'
> +
> +# Add any Sphinx extension module names here, as strings. They can be
> +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
> +# ones.
> +extensions = []
> +
> +# Add any paths that contain templates here, relative to this directory.
> +templates_path = ['_templates']
> +
> +# The suffix(es) of source filenames.
> +# You can specify multiple suffix as a list of string:
> +#
> +# source_suffix = ['.rst', '.md']
> +source_suffix = '.rst'
> +
> +# The encoding of source files.
> +#
> +# source_encoding = 'utf-8-sig'
> +
> +# The master toctree document.
> +master_doc = 'index'
> +
> +# General information about the project.
> +project = u'DRM Maintainer Tools'
> +copyright = u'2012-2017, Jani Nikula, Daniel Vetter, and others'
> +author = u'Jani Nikula, Daniel Vetter'
> +
> +# The version info for the project you're documenting, acts as replacement for
> +# |version| and |release|, also used in various other places throughout the
> +# built documents.
> +#
> +# The short X.Y version.
> +version = u'1.0'
> +# The full version, including alpha/beta/rc tags.
> +release = u'1.0'
> +
> +# The language for content autogenerated by Sphinx. Refer to documentation
> +# for a list of supported languages.
> +#
> +# This is also used if you do content translation via gettext catalogs.
> +# Usually you set "language" from the command line for these cases.
> +language = None
> +
> +# There are two options for replacing |today|: either, you set today to some
> +# non-false value, then it is used:
> +#
> +# today = ''
> +#
> +# Else, today_fmt is used as the format for a strftime call.
> +#
> +# today_fmt = '%B %d, %Y'
> +
> +# List of patterns, relative to source directory, that match files and
> +# directories to ignore when looking for source files.
> +# This patterns also effect to html_static_path and html_extra_path
> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
> +
> +# The reST default role (used for this markup: `text`) to use for all
> +# documents.
> +#
> +# default_role = None
> +
> +# If true, '()' will be appended to :func: etc. cross-reference text.
> +#
> +# add_function_parentheses = True
> +
> +# If true, the current module name will be prepended to all description
> +# unit titles (such as .. function::).
> +#
> +# add_module_names = True
> +
> +# If true, sectionauthor and moduleauthor directives will be shown in the
> +# output. They are ignored by default.
> +#
> +# show_authors = False
> +
> +# The name of the Pygments (syntax highlighting) style to use.
> +pygments_style = 'sphinx'
> +
> +# A list of ignored prefixes for module index sorting.
> +# modindex_common_prefix = []
> +
> +# If true, keep warnings as "system message" paragraphs in the built documents.
> +# keep_warnings = False
> +
> +# If true, `todo` and `todoList` produce output, else they produce nothing.
> +todo_include_todos = False
> +
> +
> +# -- Options for HTML output ----------------------------------------------
> +
> +# The theme to use for HTML and HTML Help pages.  See the documentation for
> +# a list of builtin themes.
> +#
> +html_theme = 'alabaster'
> +
> +# Theme options are theme-specific and customize the look and feel of a theme
> +# further.  For a list of options available for each theme, see the
> +# documentation.
> +#
> +# html_theme_options = {}
> +
> +# Add any paths that contain custom themes here, relative to this directory.
> +# html_theme_path = []
> +
> +# The name for this set of Sphinx documents.
> +# "<project> v<release> documentation" by default.
> +#
> +# html_title = u'DRM Maintainer Tools v1.0'
> +
> +# A shorter title for the navigation bar.  Default is the same as html_title.
> +#
> +# html_short_title = None
> +
> +# The name of an image file (relative to this directory) to place at the top
> +# of the sidebar.
> +#
> +# html_logo = None
> +
> +# The name of an image file (relative to this directory) to use as a favicon of
> +# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
> +# pixels large.
> +#
> +# html_favicon = None
> +
> +# Add any paths that contain custom static files (such as style sheets) here,
> +# relative to this directory. They are copied after the builtin static files,
> +# so a file named "default.css" will overwrite the builtin "default.css".
> +html_static_path = ['_static']
> +
> +# Add any extra paths that contain custom files (such as robots.txt or
> +# .htaccess) here, relative to this directory. These files are copied
> +# directly to the root of the documentation.
> +#
> +# html_extra_path = []
> +
> +# If not None, a 'Last updated on:' timestamp is inserted at every page
> +# bottom, using the given strftime format.
> +# The empty string is equivalent to '%b %d, %Y'.
> +#
> +# html_last_updated_fmt = None
> +
> +# If true, SmartyPants will be used to convert quotes and dashes to
> +# typographically correct entities.
> +#
> +# html_use_smartypants = True
> +
> +# Custom sidebar templates, maps document names to template names.
> +#
> +# html_sidebars = {}
> +
> +# Additional templates that should be rendered to pages, maps page names to
> +# template names.
> +#
> +# html_additional_pages = {}
> +
> +# If false, no module index is generated.
> +#
> +# html_domain_indices = True
> +
> +# If false, no index is generated.
> +#
> +# html_use_index = True
> +
> +# If true, the index is split into individual pages for each letter.
> +#
> +# html_split_index = False
> +
> +# If true, links to the reST sources are added to the pages.
> +#
> +# html_show_sourcelink = True
> +
> +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
> +#
> +# html_show_sphinx = True
> +
> +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
> +#
> +# html_show_copyright = True
> +
> +# If true, an OpenSearch description file will be output, and all pages will
> +# contain a <link> tag referring to it.  The value of this option must be the
> +# base URL from which the finished HTML is served.
> +#
> +# html_use_opensearch = ''
> +
> +# This is the file name suffix for HTML files (e.g. ".xhtml").
> +# html_file_suffix = None
> +
> +# Language to be used for generating the HTML full-text search index.
> +# Sphinx supports the following languages:
> +#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
> +#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
> +#
> +# html_search_language = 'en'
> +
> +# A dictionary with options for the search language support, empty by default.
> +# 'ja' uses this config value.
> +# 'zh' user can custom change `jieba` dictionary path.
> +#
> +# html_search_options = {'type': 'default'}
> +
> +# The name of a javascript file (relative to the configuration directory) that
> +# implements a search results scorer. If empty, the default will be used.
> +#
> +# html_search_scorer = 'scorer.js'
> +
> +# Output file base name for HTML help builder.
> +htmlhelp_basename = 'DRMMaintainerToolsdoc'
> diff --git a/index.rst b/index.rst
> new file mode 100644
> index 000000000000..d8b6d4897c45
> --- /dev/null
> +++ b/index.rst
> @@ -0,0 +1,17 @@
> +DRM Maintainer Tools
> +====================
> +
> +Contents:
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   drm-misc
> +   drm-intel
> +   dim
> +
> +Indices and tables
> +==================
> +
> +* :ref:`genindex`
> +* :ref:`search`
> --
> 2.11.0
>
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx



-- 
Rodrigo Vivi
Blog: http://blog.vivi.eng.br
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 4/5] doc: build documentation using Sphinx

[Jani Nikula]

On Thu, 10 Aug 2017, Rodrigo Vivi <rodrigo.vivi@gmail.com> wrote:
> On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
>> Based on Sphinx-quickstart, with existing and generated Makefiles merged
>> together.
>>
>> This makes the rst2html and Sphinx builds work side by side. Plain
>> 'make' continues to use rst2html, and 'make html' and friends use
>> Sphinx. The intention is to keep both for a transition period so that we
>> can have documentation autobuilders updated.
>
> the one that posts to 01.org or do we have more places pointing here?

I know of no others, but that doesn't prove anything! ;)

>
>>
>> Once we're fully converted to Sphinx, we can start looking into using
>> the graphviz (Sphinx builtin) and WaveDrom (3rd party) extensions. For
>> now, we use the same old clunky methods for including them.
>
> when we know we are fully converted?

Perhaps we can move forward with more sphinxification once 01.org has
been converted. That already builds the kernel Sphinx docs, so shouldn't
be a big deal to switch to 'make html' and copy the results over from
_build/html.

BR,
Jani.

>
>>
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> ---
>>  .gitignore |   1 +
>>  Makefile   |  61 +++++++++++++++-
>>  conf.py    | 236 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>>  index.rst  |  17 +++++
>>  4 files changed, 313 insertions(+), 2 deletions(-)
>>  create mode 100644 conf.py
>>  create mode 100644 index.rst
>>
>> diff --git a/.gitignore b/.gitignore
>> index 35ed071ca482..a176bd76eef5 100644
>> --- a/.gitignore
>> +++ b/.gitignore
>> @@ -1,3 +1,4 @@
>> +_build
>>  drm-intel-flow.svg
>>  drm-misc-commit-flow.svg
>>  *.html
>> diff --git a/Makefile b/Makefile
>> index 7059eec42720..40b7ee6e2b32 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -4,6 +4,20 @@
>>  # the wavedrom json, copy-pasting to and from http://wavedrom.com/editor.html is
>>  # handy as it shows the result live.
>>
>> +# You can set these variables from the command line.
>> +SPHINXOPTS    =
>> +SPHINXBUILD   = sphinx-build
>> +PAPER         =
>> +BUILDDIR      = _build
>> +
>> +# Internal variables.
>> +PAPEROPT_a4     = -D latex_paper_size=a4
>> +PAPEROPT_letter = -D latex_paper_size=letter
>> +ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
>> +# the i18n builder cannot share the environment and doctrees with the others
>> +I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
>> +
>> +.PHONY: all
>>  all: drm-intel.html dim.html drm-misc.html
>>
>>  %.svg: %.dot
>> @@ -41,7 +55,50 @@ mancheck:
>>
>>  check: shellcheck mancheck all
>>
>> +.PHONY: clean
>>  clean:
>> -       rm -f drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html
>> +       rm -rf drm-intel.html drm-intel-flow.svg drm-misc-commit-flow.svg dim.html drm-misc.html $(BUILDDIR)
>> +
>> +.PHONY: help
>> +help:
>> +       @echo "Please use \`make <target>' where <target> is one of"
>> +       @echo "  html       to make standalone HTML files"
>> +       @echo "  dirhtml    to make HTML files named index.html in directories"
>> +       @echo "  singlehtml to make a single large HTML file"
>> +       @echo "  linkcheck  to check all external links for integrity"
>> +       @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
>> +
>> +# FIXME: This works for the first build, but not for updates. Look into using
>> +# Sphinx extensions for both the graphviz and wavedrom parts.
>> +html dirhtml singlehtml linkcheck doctest: drm-intel-flow.svg drm-misc-commit-flow.svg
>> +
>> +.PHONY: html
>> +html:
>> +       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
>> +       @echo
>> +       @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
>> +
>> +.PHONY: dirhtml
>> +dirhtml:
>> +       $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
>> +       @echo
>> +       @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
>> +
>> +.PHONY: singlehtml
>> +singlehtml:
>> +       $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
>> +       @echo
>> +       @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
>> +
>> +.PHONY: linkcheck
>> +linkcheck:
>> +       $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
>> +       @echo
>> +       @echo "Link check complete; look for any errors in the above output " \
>> +             "or in $(BUILDDIR)/linkcheck/output.txt."
>>
>> -.PHONY: all clean
>> +.PHONY: doctest
>> +doctest:
>> +       $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
>> +       @echo "Testing of doctests in the sources finished, look at the " \
>> +             "results in $(BUILDDIR)/doctest/output.txt."
>> diff --git a/conf.py b/conf.py
>> new file mode 100644
>> index 000000000000..2e7acb8e76ca
>> --- /dev/null
>> +++ b/conf.py
>> @@ -0,0 +1,236 @@
>> +# -*- coding: utf-8 -*-
>> +#
>> +# DRM Maintainer Tools documentation build configuration file, created by
>> +# sphinx-quickstart on Wed Aug  9 17:57:16 2017.
>> +#
>> +# This file is execfile()d with the current directory set to its
>> +# containing dir.
>> +#
>> +# Note that not all possible configuration values are present in this
>> +# autogenerated file.
>> +#
>> +# All configuration values have a default; values that are commented out
>> +# serve to show the default.
>> +
>> +# If extensions (or modules to document with autodoc) are in another directory,
>> +# add these directories to sys.path here. If the directory is relative to the
>> +# documentation root, use os.path.abspath to make it absolute, like shown here.
>> +#
>> +# import os
>> +# import sys
>> +# sys.path.insert(0, os.path.abspath('.'))
>> +
>> +# -- General configuration ------------------------------------------------
>> +
>> +# If your documentation needs a minimal Sphinx version, state it here.
>> +#
>> +# needs_sphinx = '1.0'
>> +
>> +# Add any Sphinx extension module names here, as strings. They can be
>> +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
>> +# ones.
>> +extensions = []
>> +
>> +# Add any paths that contain templates here, relative to this directory.
>> +templates_path = ['_templates']
>> +
>> +# The suffix(es) of source filenames.
>> +# You can specify multiple suffix as a list of string:
>> +#
>> +# source_suffix = ['.rst', '.md']
>> +source_suffix = '.rst'
>> +
>> +# The encoding of source files.
>> +#
>> +# source_encoding = 'utf-8-sig'
>> +
>> +# The master toctree document.
>> +master_doc = 'index'
>> +
>> +# General information about the project.
>> +project = u'DRM Maintainer Tools'
>> +copyright = u'2012-2017, Jani Nikula, Daniel Vetter, and others'
>> +author = u'Jani Nikula, Daniel Vetter'
>> +
>> +# The version info for the project you're documenting, acts as replacement for
>> +# |version| and |release|, also used in various other places throughout the
>> +# built documents.
>> +#
>> +# The short X.Y version.
>> +version = u'1.0'
>> +# The full version, including alpha/beta/rc tags.
>> +release = u'1.0'
>> +
>> +# The language for content autogenerated by Sphinx. Refer to documentation
>> +# for a list of supported languages.
>> +#
>> +# This is also used if you do content translation via gettext catalogs.
>> +# Usually you set "language" from the command line for these cases.
>> +language = None
>> +
>> +# There are two options for replacing |today|: either, you set today to some
>> +# non-false value, then it is used:
>> +#
>> +# today = ''
>> +#
>> +# Else, today_fmt is used as the format for a strftime call.
>> +#
>> +# today_fmt = '%B %d, %Y'
>> +
>> +# List of patterns, relative to source directory, that match files and
>> +# directories to ignore when looking for source files.
>> +# This patterns also effect to html_static_path and html_extra_path
>> +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
>> +
>> +# The reST default role (used for this markup: `text`) to use for all
>> +# documents.
>> +#
>> +# default_role = None
>> +
>> +# If true, '()' will be appended to :func: etc. cross-reference text.
>> +#
>> +# add_function_parentheses = True
>> +
>> +# If true, the current module name will be prepended to all description
>> +# unit titles (such as .. function::).
>> +#
>> +# add_module_names = True
>> +
>> +# If true, sectionauthor and moduleauthor directives will be shown in the
>> +# output. They are ignored by default.
>> +#
>> +# show_authors = False
>> +
>> +# The name of the Pygments (syntax highlighting) style to use.
>> +pygments_style = 'sphinx'
>> +
>> +# A list of ignored prefixes for module index sorting.
>> +# modindex_common_prefix = []
>> +
>> +# If true, keep warnings as "system message" paragraphs in the built documents.
>> +# keep_warnings = False
>> +
>> +# If true, `todo` and `todoList` produce output, else they produce nothing.
>> +todo_include_todos = False
>> +
>> +
>> +# -- Options for HTML output ----------------------------------------------
>> +
>> +# The theme to use for HTML and HTML Help pages.  See the documentation for
>> +# a list of builtin themes.
>> +#
>> +html_theme = 'alabaster'
>> +
>> +# Theme options are theme-specific and customize the look and feel of a theme
>> +# further.  For a list of options available for each theme, see the
>> +# documentation.
>> +#
>> +# html_theme_options = {}
>> +
>> +# Add any paths that contain custom themes here, relative to this directory.
>> +# html_theme_path = []
>> +
>> +# The name for this set of Sphinx documents.
>> +# "<project> v<release> documentation" by default.
>> +#
>> +# html_title = u'DRM Maintainer Tools v1.0'
>> +
>> +# A shorter title for the navigation bar.  Default is the same as html_title.
>> +#
>> +# html_short_title = None
>> +
>> +# The name of an image file (relative to this directory) to place at the top
>> +# of the sidebar.
>> +#
>> +# html_logo = None
>> +
>> +# The name of an image file (relative to this directory) to use as a favicon of
>> +# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
>> +# pixels large.
>> +#
>> +# html_favicon = None
>> +
>> +# Add any paths that contain custom static files (such as style sheets) here,
>> +# relative to this directory. They are copied after the builtin static files,
>> +# so a file named "default.css" will overwrite the builtin "default.css".
>> +html_static_path = ['_static']
>> +
>> +# Add any extra paths that contain custom files (such as robots.txt or
>> +# .htaccess) here, relative to this directory. These files are copied
>> +# directly to the root of the documentation.
>> +#
>> +# html_extra_path = []
>> +
>> +# If not None, a 'Last updated on:' timestamp is inserted at every page
>> +# bottom, using the given strftime format.
>> +# The empty string is equivalent to '%b %d, %Y'.
>> +#
>> +# html_last_updated_fmt = None
>> +
>> +# If true, SmartyPants will be used to convert quotes and dashes to
>> +# typographically correct entities.
>> +#
>> +# html_use_smartypants = True
>> +
>> +# Custom sidebar templates, maps document names to template names.
>> +#
>> +# html_sidebars = {}
>> +
>> +# Additional templates that should be rendered to pages, maps page names to
>> +# template names.
>> +#
>> +# html_additional_pages = {}
>> +
>> +# If false, no module index is generated.
>> +#
>> +# html_domain_indices = True
>> +
>> +# If false, no index is generated.
>> +#
>> +# html_use_index = True
>> +
>> +# If true, the index is split into individual pages for each letter.
>> +#
>> +# html_split_index = False
>> +
>> +# If true, links to the reST sources are added to the pages.
>> +#
>> +# html_show_sourcelink = True
>> +
>> +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
>> +#
>> +# html_show_sphinx = True
>> +
>> +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
>> +#
>> +# html_show_copyright = True
>> +
>> +# If true, an OpenSearch description file will be output, and all pages will
>> +# contain a <link> tag referring to it.  The value of this option must be the
>> +# base URL from which the finished HTML is served.
>> +#
>> +# html_use_opensearch = ''
>> +
>> +# This is the file name suffix for HTML files (e.g. ".xhtml").
>> +# html_file_suffix = None
>> +
>> +# Language to be used for generating the HTML full-text search index.
>> +# Sphinx supports the following languages:
>> +#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
>> +#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
>> +#
>> +# html_search_language = 'en'
>> +
>> +# A dictionary with options for the search language support, empty by default.
>> +# 'ja' uses this config value.
>> +# 'zh' user can custom change `jieba` dictionary path.
>> +#
>> +# html_search_options = {'type': 'default'}
>> +
>> +# The name of a javascript file (relative to the configuration directory) that
>> +# implements a search results scorer. If empty, the default will be used.
>> +#
>> +# html_search_scorer = 'scorer.js'
>> +
>> +# Output file base name for HTML help builder.
>> +htmlhelp_basename = 'DRMMaintainerToolsdoc'
>> diff --git a/index.rst b/index.rst
>> new file mode 100644
>> index 000000000000..d8b6d4897c45
>> --- /dev/null
>> +++ b/index.rst
>> @@ -0,0 +1,17 @@
>> +DRM Maintainer Tools
>> +====================
>> +
>> +Contents:
>> +
>> +.. toctree::
>> +   :maxdepth: 2
>> +
>> +   drm-misc
>> +   drm-intel
>> +   dim
>> +
>> +Indices and tables
>> +==================
>> +
>> +* :ref:`genindex`
>> +* :ref:`search`
>> --
>> 2.11.0
>>
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[maintainer-tools PATCH 5/5] doc: use Sphinx bizstyle builtin html theme

[Jani Nikula]

Matter of taste, but looks better than the default alabaster, and is
less trouble than requiring some external themes (such as the sphinx rtd
theme used in the kernel).

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/conf.py b/conf.py
index 2e7acb8e76ca..7293d9ddab80 100644
--- a/conf.py
+++ b/conf.py
@@ -119,7 +119,7 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'bizstyle'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
-- 
2.11.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 5/5] doc: use Sphinx bizstyle builtin html theme

[Rodrigo Vivi]

On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
> Matter of taste, but looks better than the default alabaster,

not sure which one I preferred...
alabaster goes better with 01.org... but it indeed is not very good...

> and is
> less trouble than requiring some external themes (such as the sphinx rtd
> theme used in the kernel).

less trouble is good, but since we are already making changes now and
forcing new packages I believe we could force to use same style as
kernel so we keep in sync...

>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
>  conf.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/conf.py b/conf.py
> index 2e7acb8e76ca..7293d9ddab80 100644
> --- a/conf.py
> +++ b/conf.py
> @@ -119,7 +119,7 @@ todo_include_todos = False
>  # The theme to use for HTML and HTML Help pages.  See the documentation for
>  # a list of builtin themes.
>  #
> -html_theme = 'alabaster'
> +html_theme = 'bizstyle'
>
>  # Theme options are theme-specific and customize the look and feel of a theme
>  # further.  For a list of options available for each theme, see the
> --
> 2.11.0
>
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx



-- 
Rodrigo Vivi
Blog: http://blog.vivi.eng.br
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 5/5] doc: use Sphinx bizstyle builtin html theme

[Jani Nikula]

On Thu, 10 Aug 2017, Rodrigo Vivi <rodrigo.vivi@gmail.com> wrote:
> On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
>> Matter of taste, but looks better than the default alabaster,
>
> not sure which one I preferred...
> alabaster goes better with 01.org... but it indeed is not very good...
>
>> and is
>> less trouble than requiring some external themes (such as the sphinx rtd
>> theme used in the kernel).
>
> less trouble is good, but since we are already making changes now and
> forcing new packages I believe we could force to use same style as
> kernel so we keep in sync...

Looks like sphinx_rtd_theme is builtin since Sphinx 1.3, and I think we
could easily require that.

The trouble is that the sphinx_rtd_theme forces a fairly narrow layout
horizontally, without horizontal scroll bars, and the wavedrom timeline
overflows the content box and is clipped at the window border. Fail.

I peeked at the Sphinx wavedrom extension, and incorporated their raw
html hack to provide scrollbars for overflowing content. With hack [1],
without hack [2].

What do people think?

(Perhaps the right answer is to use something other than wavedrom
altogether, but I don't have the time and I don't want it to block the
Sphinx conversion.)


BR,
Jani.


[1] https://people.freedesktop.org/~jani/html/drm-intel.html#merge-timeline
[2] https://people.freedesktop.org/~jani/html/drm-misc.html#merge-timeline



>
>>
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> ---
>>  conf.py | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/conf.py b/conf.py
>> index 2e7acb8e76ca..7293d9ddab80 100644
>> --- a/conf.py
>> +++ b/conf.py
>> @@ -119,7 +119,7 @@ todo_include_todos = False
>>  # The theme to use for HTML and HTML Help pages.  See the documentation for
>>  # a list of builtin themes.
>>  #
>> -html_theme = 'alabaster'
>> +html_theme = 'bizstyle'
>>
>>  # Theme options are theme-specific and customize the look and feel of a theme
>>  # further.  For a list of options available for each theme, see the
>> --
>> 2.11.0
>>
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 5/5] doc: use Sphinx bizstyle builtin html theme

[Rodrigo Vivi]

On Thu, Aug 10, 2017 at 12:22 AM, Jani Nikula <jani.nikula@intel.com> wrote:
> On Thu, 10 Aug 2017, Rodrigo Vivi <rodrigo.vivi@gmail.com> wrote:
>> On Wed, Aug 9, 2017 at 2:08 PM, Jani Nikula <jani.nikula@intel.com> wrote:
>>> Matter of taste, but looks better than the default alabaster,
>>
>> not sure which one I preferred...
>> alabaster goes better with 01.org... but it indeed is not very good...
>>
>>> and is
>>> less trouble than requiring some external themes (such as the sphinx rtd
>>> theme used in the kernel).
>>
>> less trouble is good, but since we are already making changes now and
>> forcing new packages I believe we could force to use same style as
>> kernel so we keep in sync...
>
> Looks like sphinx_rtd_theme is builtin since Sphinx 1.3, and I think we
> could easily require that.
>
> The trouble is that the sphinx_rtd_theme forces a fairly narrow layout
> horizontally, without horizontal scroll bars, and the wavedrom timeline
> overflows the content box and is clipped at the window border. Fail.
>
> I peeked at the Sphinx wavedrom extension, and incorporated their raw
> html hack to provide scrollbars for overflowing content. With hack [1],
> without hack [2].
>
> What do people think?

I really don't see difference between them here. (on Google Chrome browser)
Both cases are without horizontal scrollbar but text adjust itself
pretty good in both cases.

So, no preference...

>
> (Perhaps the right answer is to use something other than wavedrom
> altogether, but I don't have the time and I don't want it to block the
> Sphinx conversion.)

I think it is great the way it is ;)

>
>
> BR,
> Jani.
>
>
> [1] https://people.freedesktop.org/~jani/html/drm-intel.html#merge-timeline
> [2] https://people.freedesktop.org/~jani/html/drm-misc.html#merge-timeline
>
>
>
>>
>>>
>>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>>> ---
>>>  conf.py | 2 +-
>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/conf.py b/conf.py
>>> index 2e7acb8e76ca..7293d9ddab80 100644
>>> --- a/conf.py
>>> +++ b/conf.py
>>> @@ -119,7 +119,7 @@ todo_include_todos = False
>>>  # The theme to use for HTML and HTML Help pages.  See the documentation for
>>>  # a list of builtin themes.
>>>  #
>>> -html_theme = 'alabaster'
>>> +html_theme = 'bizstyle'
>>>
>>>  # Theme options are theme-specific and customize the look and feel of a theme
>>>  # further.  For a list of options available for each theme, see the
>>> --
>>> 2.11.0
>>>
>>> _______________________________________________
>>> Intel-gfx mailing list
>>> Intel-gfx@lists.freedesktop.org
>>> https://lists.freedesktop.org/mailman/listinfo/intel-gfx
>
> --
> Jani Nikula, Intel Open Source Technology Center



-- 
Rodrigo Vivi
Blog: http://blog.vivi.eng.br
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[maintainer-tools PATCH 6/5] doc: load WaveDrom scripts directly from CDN instead of bundling

[Jani Nikula]

Way back when the WaveDrom stuff was added, the scripts could only be
accessed over http. This caused issues with sites served over https and
modern browsers rightly complaining about mixed content. This was worked
around by downloading the WaveDrom scripts over http at build time, and
bundling them inline into the http.

Now that WaveDrom is available over https, simplify the hackery, and let
the user's browser load the scripts directly at page load time.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 drm-intel-timeline.rst | 20 +++-----------------
 drm-misc-timeline.rst  | 21 +++------------------
 2 files changed, 6 insertions(+), 35 deletions(-)

diff --git a/drm-intel-timeline.rst b/drm-intel-timeline.rst
index 3ab39afd5788..fe69fd374cf6 100644
--- a/drm-intel-timeline.rst
+++ b/drm-intel-timeline.rst
@@ -1,22 +1,8 @@
 .. raw:: html
 
-	<script type="text/javascript">
-	/* Embedded WaveDrom skin from http://wavedrom.com/skins/default.js */
-
-.. raw:: html
-	:url: http://wavedrom.com/skins/default.js
-
-.. raw:: html
-
-	</script>
-	<script type="text/javascript">
-	/* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
-
-.. raw:: html
-	:url: http://wavedrom.com/WaveDrom.js
-
-.. raw:: html
-
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/skins/default.js" type="text/javascript"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/wavedrom.min.js" type="text/javascript"></script>
+	<script>
 	function init() {
 		WaveDrom.ProcessAll();
 	}
diff --git a/drm-misc-timeline.rst b/drm-misc-timeline.rst
index a9a80d6a4cfb..76eb780ebd0a 100644
--- a/drm-misc-timeline.rst
+++ b/drm-misc-timeline.rst
@@ -1,27 +1,13 @@
 .. raw:: html
 
-	<script type="text/javascript">
-	/* Embedded WaveDrom skin from http://wavedrom.com/skins/default.js */
-
-.. raw:: html
-	:url: http://wavedrom.com/skins/default.js
-
-.. raw:: html
-
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/skins/default.js" type="text/javascript"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/wavedrom.min.js" type="text/javascript"></script>
+	<script>
 	function init() {
 		WaveDrom.ProcessAll();
 	}
 	window.onload = init;
 	</script>
-	<script type="text/javascript">
-	/* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
-
-.. raw:: html
-	:url: http://wavedrom.com/WaveDrom.js
-
-.. raw:: html
-
-	</script>
 	<script type="WaveDrom">
 
 .. raw:: html
@@ -30,4 +16,3 @@
 .. raw:: html
 
 	</script>
-
-- 
2.11.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 6/5] doc: load WaveDrom scripts directly from CDN instead of bundling

[Rodrigo Vivi]

On Wed, Aug 9, 2017 at 2:33 PM, Jani Nikula <jani.nikula@intel.com> wrote:
> Way back when the WaveDrom stuff was added, the scripts could only be
> accessed over http. This caused issues with sites served over https and
> modern browsers rightly complaining about mixed content. This was worked
> around by downloading the WaveDrom scripts over http at build time, and
> bundling them inline into the http.
>
> Now that WaveDrom is available over https, simplify the hackery, and let
> the user's browser load the scripts directly at page load time.
>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
>  drm-intel-timeline.rst | 20 +++-----------------
>  drm-misc-timeline.rst  | 21 +++------------------
>  2 files changed, 6 insertions(+), 35 deletions(-)
>
> diff --git a/drm-intel-timeline.rst b/drm-intel-timeline.rst
> index 3ab39afd5788..fe69fd374cf6 100644
> --- a/drm-intel-timeline.rst
> +++ b/drm-intel-timeline.rst
> @@ -1,22 +1,8 @@
>  .. raw:: html
>
> -       <script type="text/javascript">
> -       /* Embedded WaveDrom skin from http://wavedrom.com/skins/default.js */
> -
> -.. raw:: html
> -       :url: http://wavedrom.com/skins/default.js
> -
> -.. raw:: html
> -
> -       </script>
> -       <script type="text/javascript">
> -       /* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
> -
> -.. raw:: html
> -       :url: http://wavedrom.com/WaveDrom.js
> -
> -.. raw:: html
> -
> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/skins/default.js" type="text/javascript"></script>
> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/wavedrom.min.js" type="text/javascript"></script>

is wavedrom.min.js same as wavedrom.js?

> +       <script>
>         function init() {
>                 WaveDrom.ProcessAll();
>         }
> diff --git a/drm-misc-timeline.rst b/drm-misc-timeline.rst
> index a9a80d6a4cfb..76eb780ebd0a 100644
> --- a/drm-misc-timeline.rst
> +++ b/drm-misc-timeline.rst
> @@ -1,27 +1,13 @@
>  .. raw:: html
>
> -       <script type="text/javascript">
> -       /* Embedded WaveDrom skin from http://wavedrom.com/skins/default.js */
> -
> -.. raw:: html
> -       :url: http://wavedrom.com/skins/default.js
> -
> -.. raw:: html
> -
> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/skins/default.js" type="text/javascript"></script>
> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/wavedrom.min.js" type="text/javascript"></script>
> +       <script>
>         function init() {
>                 WaveDrom.ProcessAll();
>         }
>         window.onload = init;
>         </script>
> -       <script type="text/javascript">
> -       /* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
> -
> -.. raw:: html
> -       :url: http://wavedrom.com/WaveDrom.js
> -
> -.. raw:: html
> -
> -       </script>
>         <script type="WaveDrom">
>
>  .. raw:: html
> @@ -30,4 +16,3 @@
>  .. raw:: html
>
>         </script>
> -
> --
> 2.11.0
>
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx



-- 
Rodrigo Vivi
Blog: http://blog.vivi.eng.br
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [maintainer-tools PATCH 6/5] doc: load WaveDrom scripts directly from CDN instead of bundling

[Jani Nikula]

On Thu, 10 Aug 2017, Rodrigo Vivi <rodrigo.vivi@gmail.com> wrote:
> On Wed, Aug 9, 2017 at 2:33 PM, Jani Nikula <jani.nikula@intel.com> wrote:
>> Way back when the WaveDrom stuff was added, the scripts could only be
>> accessed over http. This caused issues with sites served over https and
>> modern browsers rightly complaining about mixed content. This was worked
>> around by downloading the WaveDrom scripts over http at build time, and
>> bundling them inline into the http.
>>
>> Now that WaveDrom is available over https, simplify the hackery, and let
>> the user's browser load the scripts directly at page load time.
>>
>> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> ---
>>  drm-intel-timeline.rst | 20 +++-----------------
>>  drm-misc-timeline.rst  | 21 +++------------------
>>  2 files changed, 6 insertions(+), 35 deletions(-)
>>
>> diff --git a/drm-intel-timeline.rst b/drm-intel-timeline.rst
>> index 3ab39afd5788..fe69fd374cf6 100644
>> --- a/drm-intel-timeline.rst
>> +++ b/drm-intel-timeline.rst
>> @@ -1,22 +1,8 @@
>>  .. raw:: html
>>
>> -       <script type="text/javascript">
>> -       /* Embedded WaveDrom skin from http://wavedrom.com/skins/default.js */
>> -
>> -.. raw:: html
>> -       :url: http://wavedrom.com/skins/default.js
>> -
>> -.. raw:: html
>> -
>> -       </script>
>> -       <script type="text/javascript">
>> -       /* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
>> -
>> -.. raw:: html
>> -       :url: http://wavedrom.com/WaveDrom.js
>> -
>> -.. raw:: html
>> -
>> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/skins/default.js" type="text/javascript"></script>
>> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/wavedrom.min.js" type="text/javascript"></script>
>
> is wavedrom.min.js same as wavedrom.js?

I just copy-pasted the CDN link from [1], but diffing them confirms
they're the same.

BR,
Jani.


[1] https://github.com/drom/wavedrom#html-pages

>
>> +       <script>
>>         function init() {
>>                 WaveDrom.ProcessAll();
>>         }
>> diff --git a/drm-misc-timeline.rst b/drm-misc-timeline.rst
>> index a9a80d6a4cfb..76eb780ebd0a 100644
>> --- a/drm-misc-timeline.rst
>> +++ b/drm-misc-timeline.rst
>> @@ -1,27 +1,13 @@
>>  .. raw:: html
>>
>> -       <script type="text/javascript">
>> -       /* Embedded WaveDrom skin from http://wavedrom.com/skins/default.js */
>> -
>> -.. raw:: html
>> -       :url: http://wavedrom.com/skins/default.js
>> -
>> -.. raw:: html
>> -
>> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/skins/default.js" type="text/javascript"></script>
>> +       <script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/1.4.1/wavedrom.min.js" type="text/javascript"></script>
>> +       <script>
>>         function init() {
>>                 WaveDrom.ProcessAll();
>>         }
>>         window.onload = init;
>>         </script>
>> -       <script type="text/javascript">
>> -       /* Embedded WaveDrom engine from http://wavedrom.com/WaveDrom.js */
>> -
>> -.. raw:: html
>> -       :url: http://wavedrom.com/WaveDrom.js
>> -
>> -.. raw:: html
>> -
>> -       </script>
>>         <script type="WaveDrom">
>>
>>  .. raw:: html
>> @@ -30,4 +16,3 @@
>>  .. raw:: html
>>
>>         </script>
>> -
>> --
>> 2.11.0
>>
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx