Replace custom theme with sphinx-ansible-theme #856

ssbarnea · 2020-06-23T16:08:13Z

remove custom sphinx theme from our codebase
reuse shared sphinx-ansible-theme
removed docs makefiles

webknjaz

It's easier to merge #858 first. This way you'd not have to modify makefile stuff making this change easier to accept too.

docs/docsite/rst/conf.py

webknjaz · 2020-06-26T19:59:19Z

docs/docsite/rst/conf.py

+# the extension builds 404.rst into a location-agnostic 404 page
+#
+# default is `en` - using this for the sub-site:
+notfound_default_language = "ansible"


What is this?

Got it from Ansible itself, a guess is default code-block when language is not mentioned i or unknown.

docs/docsite/rst/conf.py

lib/ansiblelint/__init__.py

webknjaz

i've marked some things that obviously don't belong here.

README.rst

lib/ansiblelint/__init__.py

setup.cfg

tox.ini

docs/docsite/Makefile.sphinx

webknjaz · 2020-06-26T20:10:26Z

.readthedocs.yml

+---
+version: 2
+
+formats: all
+
+build:
+  image: latest
+
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs


out of scope

docs/docsite/rst/conf.py

webknjaz · 2020-06-26T20:12:46Z

docs/docsite/rst/conf.py

+    'github_version': 'master/docs/',
+    'current_version': version,
+    'latest_version': 'latest',
+    # list specifically out of order to make latest work


docs/docsite/rst/conf.py

.flake8

.readthedocs.yml

webknjaz · 2020-06-27T13:03:37Z

docs/docsite/rst/conf.py


-import sys
-import os
+import datetime


Refactoring this module is out of scope. The change should only contain the integration of the new theme.

docs/requirements.txt

lib/ansiblelint/__init__.py

tox.ini

.readthedocs.yml

webknjaz · 2020-06-29T17:24:36Z

docs/_themes/sphinx_rtd_theme/static/images/logo_invert.png

@ssbarnea should we keep this?

ssbarnea · 2020-06-29T17:26:19Z

Feel free to make any changes you want to the conf.py, i will not mind as long it builds with them.

docs/docsite/README.md

webknjaz · 2020-06-29T17:29:00Z

docs/rst/conf.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+"""Sphinx configuration."""


I don't think it should be moved here. Also it doesn't seem related to changing the theme anyway.

webknjaz · 2020-06-29T17:29:41Z

docs/rst/conf.py

-# pip install sphinx_rtd_theme
-# import sphinx_rtd_theme
-# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# pip install sphinx_ansible_theme


I don't think this is useful since all the supported configs have this info in the right place

Suggested change

# pip install sphinx_ansible_theme

webknjaz · 2020-06-29T17:30:22Z

docs/rst/conf.py

-# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# pip install sphinx_ansible_theme
+import sphinx_ansible_theme
+from ansiblelint import __version__, __package__


Setting up version vars is out of scope and should be in a separate PR.

docs/rst/conf.py

webknjaz

This PR should only contain bits related to adding a theme. All other changes are welcome to be submitted separately.

I remove almost all changes from conf.py to avoid delaying this even more.

- remove custom sphinx theme from our codebase - reuse shared sphinx-ansible-theme

webknjaz

Please answer this question:

docs/_themes/sphinx_rtd_theme/static/images/logo_invert.png

@ssbarnea should we keep this?

Also, for any change you want to do as a follow-up I expect a comment and maybe a link to an issue documenting that this needs to be done.

docs/README.md

docs/requirements.in

.readthedocs.yml

docs/rst/conf.py

ssbarnea · 2020-06-30T10:03:31Z

Please answer this question:

docs/_themes/sphinx_rtd_theme/static/images/logo_invert.png

@ssbarnea should we keep this?

Also, for any change you want to do as a follow-up I expect a comment and maybe a link to an issue documenting that this needs to be done.

That is Ansible owns logo, now included with the theme. No need to keep it.

ssbarnea requested a review from webknjaz June 24, 2020 06:49

webknjaz suggested changes Jun 25, 2020

View reviewed changes

ssbarnea changed the title ~~WIP: Replace custom theme with sphinx-ansible-theme~~ Replace custom theme with sphinx-ansible-theme Jun 26, 2020

ssbarnea marked this pull request as ready for review June 26, 2020 19:29

ssbarnea requested a review from webknjaz June 26, 2020 19:30

ssbarnea added the documentation label Jun 26, 2020

webknjaz reviewed Jun 26, 2020

View reviewed changes

docs/docsite/rst/conf.py Outdated Show resolved Hide resolved

webknjaz reviewed Jun 26, 2020

View reviewed changes

docs/docsite/rst/conf.py Outdated Show resolved Hide resolved

webknjaz reviewed Jun 26, 2020

View reviewed changes

lib/ansiblelint/__init__.py Outdated Show resolved Hide resolved

webknjaz reviewed Jun 26, 2020

View reviewed changes

lib/ansiblelint/__init__.py Outdated Show resolved Hide resolved

webknjaz suggested changes Jun 26, 2020

View reviewed changes

webknjaz reviewed Jun 27, 2020

View reviewed changes

.flake8 Outdated Show resolved Hide resolved

webknjaz suggested changes Jun 27, 2020

View reviewed changes

webknjaz reviewed Jun 29, 2020

View reviewed changes

.readthedocs.yml Show resolved Hide resolved

webknjaz reviewed Jun 29, 2020

View reviewed changes

docs/docsite/README.md Outdated Show resolved Hide resolved

webknjaz reviewed Jun 29, 2020

View reviewed changes

docs/rst/conf.py Outdated Show resolved Hide resolved

webknjaz previously requested changes Jun 29, 2020

View reviewed changes

ssbarnea requested a review from webknjaz June 30, 2020 07:46

Replace custom theme with sphinx-ansible-theme

3858c32

- remove custom sphinx theme from our codebase - reuse shared sphinx-ansible-theme

webknjaz suggested changes Jun 30, 2020

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

docs/requirements.in Show resolved Hide resolved

.readthedocs.yml Show resolved Hide resolved

docs/rst/conf.py Show resolved Hide resolved

webknjaz approved these changes Jun 30, 2020

View reviewed changes

ssbarnea merged commit 49f09a5 into ansible:master Jun 30, 2020

ssbarnea deleted the theme branch June 30, 2020 10:15

ssbarnea added the enhancement label Aug 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace custom theme with sphinx-ansible-theme #856

Replace custom theme with sphinx-ansible-theme #856

ssbarnea commented Jun 23, 2020 •

edited

Loading

webknjaz left a comment

webknjaz Jun 26, 2020

ssbarnea Jun 29, 2020 •

edited

Loading

webknjaz left a comment

webknjaz Jun 26, 2020

webknjaz Jun 26, 2020

webknjaz Jun 27, 2020

webknjaz commented Jun 29, 2020

ssbarnea commented Jun 29, 2020

webknjaz Jun 29, 2020

webknjaz Jun 29, 2020

webknjaz Jun 29, 2020

webknjaz left a comment

webknjaz left a comment

ssbarnea commented Jun 30, 2020

		@@ -1,4 +1,5 @@
		# -- coding: utf-8 --
		"""Sphinx configuration."""

Replace custom theme with sphinx-ansible-theme #856

Replace custom theme with sphinx-ansible-theme #856

Conversation

ssbarnea commented Jun 23, 2020 • edited Loading

webknjaz left a comment

Choose a reason for hiding this comment

webknjaz Jun 26, 2020

Choose a reason for hiding this comment

ssbarnea Jun 29, 2020 • edited Loading

Choose a reason for hiding this comment

webknjaz left a comment

Choose a reason for hiding this comment

webknjaz Jun 26, 2020

Choose a reason for hiding this comment

webknjaz Jun 26, 2020

Choose a reason for hiding this comment

webknjaz Jun 27, 2020

Choose a reason for hiding this comment

webknjaz commented Jun 29, 2020

ssbarnea commented Jun 29, 2020

webknjaz Jun 29, 2020

Choose a reason for hiding this comment

webknjaz Jun 29, 2020

Choose a reason for hiding this comment

webknjaz Jun 29, 2020

Choose a reason for hiding this comment

webknjaz left a comment

Choose a reason for hiding this comment

webknjaz left a comment

Choose a reason for hiding this comment

ssbarnea commented Jun 30, 2020

ssbarnea commented Jun 23, 2020 •

edited

Loading

ssbarnea Jun 29, 2020 •

edited

Loading