WIP: Use upstream sphinx templates #21

jayvdb · 2018-05-30T00:39:05Z

No description provided.

jayvdb · 2018-05-30T00:40:11Z

One part is not backwards compatible: variable sphinx_extensions, replacing block SPHINX_EXTENSIONS

jayvdb · 2018-05-30T00:42:19Z

jayvdb · 2018-05-30T00:44:55Z

templates/conf.py.jj2

-{%block SPHINX_EXTENSIONS%}
-{%endblock%}
-]
-{%block custom_varaibles%}


this is #20

jayvdb · 2018-05-30T00:46:04Z

templates/conf.py.jj2

-]
-{%block custom_varaibles%}
-{%endblock%}
-intersphinx_mapping = {


this is the only difference between the two conf.py.jj2 , and it doesnt seem worthwhile having two different templates if this is the only difference.

jayvdb · 2018-05-30T00:50:44Z

templates/docs/master_doc.rst_t

@@ -0,0 +1,21 @@
+.. {{ project }} documentation master file, created by
+   sphinx-quickstart on {{ now }}.


The "created by sphinx-quickstart" is a bit annoying, and is an example of how copy targets might be modified , here after copy, replace "sphinx-quickstart" with moban or yehua

{{ now }} doesnt exist yet, and is a bad idea for re-generated files.

maybe we can delete these lines by building a slightly different 'include' command.

chfw · 2018-05-30T07:02:15Z

templates/docs/conf.py_t

+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'


html_theme overrides previous html_theme variable.

The include is first. Then our template overrides the hardcoded value.

long term ... I'll propose enhancements to sphinx-quickstart so these hacks can be removed.

chfw · 2018-05-30T07:15:02Z

.travis.yml

+  - git clone https://github.com/sphinx-doc/sphinx ../sphinx
+  - (cd .. && ln -s sphinx/sphinx/templates/quickstart/ sphinx-quickstart-templates)
+  # Check upstream mobans are in sync
+  - moban -m upstream.yml


I think this command will update sphinx related files in the repo and then the tests will be performed on top of them. Do you imagine that we update them offline? for example, when the build fails, and we try to update those sphinx files, e.g. Make.bat.jj2. How would the update work?

Yea, build breaks due to upstream changes and we copy if the changes are good, or we pin the git clone to last good sha if the changes are undesirable, or we break the sync if upstream isnt usable anymore.

Im doing the same with AppVeyor https://gitlab.com/coala/mobans/merge_requests/22 , and will bring those templates here when ive finished. Im going to try getting the appveyor.yml.jj2 merged upstream.

I believe make.bat should not be templated and must be autogenerated. Refer this. I believe changes must be done in setup.py to autogenerate this.

jayvdb · 2018-05-30T07:06:39Z

templates/docs/conf.py_t

@@ -0,0 +1,209 @@
+# -*- coding: utf-8 -*-


This appears twice in the file.

moremoban/moban#60 and moremoban/moban#36

jayvdb · 2018-05-30T09:04:02Z

.travis.yml

+  - git clone https://github.com/sphinx-doc/sphinx ../sphinx
+  - (cd .. && ln -s sphinx/sphinx/templates/quickstart/ sphinx-quickstart-templates)
+  # Check upstream mobans are in sync
+  - moban -m upstream.yml


Yea, build breaks due to upstream changes and we copy if the changes are good, or we pin the git clone to last good sha if the changes are undesirable, or we break the sync if upstream isnt usable anymore.

Im doing the same with AppVeyor https://gitlab.com/coala/mobans/merge_requests/22 , and will bring those templates here when ive finished. Im going to try getting the appveyor.yml.jj2 merged upstream.

jayvdb · 2018-05-30T09:05:53Z

templates/docs/conf.py_t

+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'


long term ... I'll propose enhancements to sphinx-quickstart so these hacks can be removed.

jayvdb · 2018-06-08T15:03:11Z

templates/docs/index.rst.jj2

@@ -0,0 +1,13 @@
+{% macro underlines(name) %}


I think it might be possible to share this macro with templates/docs/source/index.rst.jj2

jayvdb · 2018-06-08T15:05:16Z

templates/docs/index.rst.jj2

@@ -0,0 +1,13 @@
+{% macro underlines(name) %}
+{%- for i in range(name|length) -%}={%- endfor -%}


this algorithm doesnt account for wide-width glyphs. For that, I think jinja doesnt have built in functions to determine the width, so we need moban plugins.
But this is good enough for now.

have you tried https://github.com/moremoban/moban#split_length?

jayvdb · 2018-06-08T16:38:09Z

Before merging, I want to sync a repo with these changes to check what it looks like.

chfw · 2018-06-08T16:42:39Z

templates/docs/source/index.rst.jj2

@@ -0,0 +1,6 @@
+{% macro underlines(name) %}


what's the purpose of two index.rst.jj2 here?

This one is for the source, and the other is for the user docs.

c.f. https://github.com/moremoban/pypi-mobans/pull/21/files#r194086916

jayvdb commented May 30, 2018

View reviewed changes

jayvdb mentioned this pull request May 30, 2018

Creating jinja2 templates from example files which have static values moremoban/moban#25

Open

chfw reviewed May 30, 2018

View reviewed changes

jayvdb commented Jun 7, 2018

View reviewed changes

jayvdb force-pushed the sphinx-templates branch 4 times, most recently from 4563612 to dfd4b86 Compare June 7, 2018 19:34

jayvdb mentioned this pull request Jun 7, 2018

WIP: moban sync moremoban/yehua#10

Merged

jayvdb force-pushed the sphinx-templates branch 2 times, most recently from 44e2091 to a4be270 Compare June 7, 2018 20:15

✨ use upstream sphinx templates

a4be270

jayvdb changed the title ~~WIP: Use upstream sphinx templates~~ Use upstream sphinx templates Jun 7, 2018

jayvdb commented Jun 8, 2018

View reviewed changes

jayvdb changed the title ~~Use upstream sphinx templates~~ WIP: Use upstream sphinx templates Jun 8, 2018

jayvdb commented Jun 8, 2018

View reviewed changes

chfw reviewed Jun 8, 2018

View reviewed changes

chfw merged commit 47e4276 into moremoban:master Jun 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Use upstream sphinx templates #21

WIP: Use upstream sphinx templates #21

jayvdb commented May 30, 2018

jayvdb commented May 30, 2018

jayvdb commented May 30, 2018 •

edited

Loading

jayvdb May 30, 2018

jayvdb May 30, 2018

jayvdb May 30, 2018

chfw May 30, 2018

jayvdb May 30, 2018

chfw May 30, 2018

jayvdb May 30, 2018

chfw May 30, 2018

jayvdb May 30, 2018

ankitxjoshi Jun 7, 2018

jayvdb May 30, 2018

jayvdb Jun 7, 2018

jayvdb May 30, 2018

jayvdb May 30, 2018

jayvdb Jun 8, 2018

jayvdb Jun 8, 2018

chfw Jun 10, 2018

jayvdb commented Jun 8, 2018

chfw Jun 8, 2018

jayvdb Jun 9, 2018

		@@ -0,0 +1,21 @@
		.. {{ project }} documentation master file, created by
		sphinx-quickstart on {{ now }}.

		@@ -0,0 +1,13 @@
		{% macro underlines(name) %}
		{%- for i in range(name\|length) -%}={%- endfor -%}

WIP: Use upstream sphinx templates #21

WIP: Use upstream sphinx templates #21

Conversation

jayvdb commented May 30, 2018

jayvdb commented May 30, 2018

jayvdb commented May 30, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jayvdb commented Jun 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jayvdb commented May 30, 2018 •

edited

Loading