Switch docs theme to furo (#7078)

* Swapped docs theme to furo. * Tidy up some python 2 bits and commented out theme related config that isn't needed. * Install the docs requirements with the unit tests because there's a unit test for docs * Cleaning up some refs to divio which are no longer valid * Updated security emails * djangoCMS -> django CMS
django-cms · Jun 24, 2021 · f324378 · f324378
1 parent 06dc95b
commit f324378
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 67 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -45,6 +45,7 @@ jobs:
         pip install pytest
         pip install -r test_requirements/${{ matrix.requirements-file }}
         pip install -r test_requirements/databases.txt
+        pip install -r docs/requirements.txt
         python setup.py install
 
     - name: Test with django test runner
@@ -94,6 +95,7 @@ jobs:
         pip install pytest
         pip install -r test_requirements/${{ matrix.requirements-file }}
         pip install -r test_requirements/databases.txt
+        pip install -r docs/requirements.txt
         python setup.py install
 
 
@@ -131,6 +133,7 @@ jobs:
         python -m pip install --upgrade pip
         pip install pytest
         pip install -r test_requirements/${{ matrix.requirements-file }}
+        pip install -r docs/requirements.txt
         python setup.py install
 
     - name: Test with django test runner

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -18,39 +18,39 @@ All participants in our community and its various forums are expected to abide b
 Issues
 ======
 
-* Please report **any bugs** through `GitHub issues <https://github.com/divio/django-cms/issues>`_.
+* Please report **any bugs** through `GitHub issues <https://github.com/django-cms/django-cms/issues>`_.
 * For *security issues* please see further below.
 
-Contributing Code 
+Contributing Code
 ================
 
 Here’s what the pull request process looks like in brief:
 
 1. Fork our GitHub repository, https://github.com/django-cms/django-cms
 2. Work locally and push your changes to your repository.
 3. When you feel your code is good enough for inclusion, send us a pull request.
-4. After that, please join the `Slack Channel <https://www.django-cms.org/slack>`_ of our Pull Request Review work group (#workgroup-pr-review). This group of friendly community members is dedicated to reviewing pull requests. Report your PR and find a “pr review buddy” who is going to review your pull request. 
+4. After that, please join the `Slack Channel <https://www.django-cms.org/slack>`_ of our Pull Request Review work group (#workgroup-pr-review). This group of friendly community members is dedicated to reviewing pull requests. Report your PR and find a “pr review buddy” who is going to review your pull request.
 5. Get acknowledged by the django CMS community for your contribution :-)
 
-To learn more about basic requirements and standards of code contribution, please familiarize yourself with our comprehensive `documentation <https://docs.django-cms.org/en/latest/contributing/code.html#>`_. 
+To learn more about basic requirements and standards of code contribution, please familiarize yourself with our comprehensive `documentation <https://docs.django-cms.org/en/latest/contributing/code.html#>`_.
 
 django CMS commits follow the `Conventionnal Commits Guideline <http://conventionnalcommits.org/>`_ , please try to follow the Guidelines in your commit messages to ease our review&merge process.
 
 
 Proposing large feature additions
 =================================
 
-In terms of proposing large feature additions, we follow the best practice of `DEPS <https://github.com/django/deps>`_. 
+In terms of proposing large feature additions, we follow the best practice of `DEPS <https://github.com/django/deps>`_.
 
 To create a proposal...
 
 1. please use this `DEP <https://github.com/django/deps/blob/main/template.rst>`_ template
 
 2. create a discussion in the main `django CMS repository <https://github.com/django-cms/django-cms/discussions>`_
 
-3. join the `Tech Committee <https:/github.com/django-cms/django-cms-mgmt/blob/master/tech-committee/about.md>`_ `Slack Channel <https://www.django-cms.org/slack>`_ (#technical-committee) and ask for a RFC. 
+3. join the `Tech Committee <https:/github.com/django-cms/django-cms-mgmt/blob/master/tech-committee/about.md>`_ `Slack Channel <https://www.django-cms.org/slack>`_ (#technical-committee) and ask for a RFC.
 
-4. After RFC is completed, add the proposal to the `agenda <https://hackmd.io/ddhvq_aqS6my9gwhLddyPg>`_ of the TC for approval. 
+4. After RFC is completed, add the proposal to the `agenda <https://hackmd.io/ddhvq_aqS6my9gwhLddyPg>`_ of the TC for approval.
 
 
 Contribution documentation
@@ -70,7 +70,7 @@ If you think you have discovered a security issue in our code, please do not rai
 forum until we have had a chance to deal with it.
 
 
-Community & Association 
+Community & Association
 =======================
 
 You can join us online:
@@ -97,7 +97,7 @@ Receive rewards for submitting pull requests
 Sign up for our `Bounty program <https://www.django-cms.org/en/bounty-program/>`_.
 
 
-Join a work group 
+Join a work group
 =================
 
-As part of the django CMS Association we have formed several `work groups <https://docs.django-cms.org/en/latest/contributing/code.html#>`_ to work together on different django CMS development topics. If you want to become part of contributor team, feel free to join one of our groups. You will meet friendly people and improve your programing skills and make a real difference in the django CMS open source project. 
+As part of the django CMS Association we have formed several `work groups <https://docs.django-cms.org/en/latest/contributing/code.html#>`_ to work together on different django CMS development topics. If you want to become part of contributor team, feel free to join one of our groups. You will meet friendly people and improve your programing skills and make a real difference in the django CMS open source project.
diff --git a/README.rst b/README.rst
@@ -98,15 +98,15 @@ You can use the `django CMS installer <https://djangocms-installer.readthedocs.i
 Demo
 ****
 
-.. image:: https://raw.githubusercontent.com/divio/django-cms/develop/docs/images/try-with-divio.png
+.. image:: https://raw.githubusercontent.com/django-cms/django-cms/develop/docs/images/try-with-divio.png
    :target: https://control.divio.com/demo/get-new/django-cms/
    :alt: Try demo with Divio Cloud
 
 ************
 Getting Help
 ************
 
-Please head over to our `Slack channel <https://www.django-cms.org/slack>`_ or our `discourse forum <https://discourse.django-cms.org/>`_ for support. 
+Please head over to our `Slack channel <https://www.django-cms.org/slack>`_ or our `discourse forum <https://discourse.django-cms.org/>`_ for support.
 
 ******************
 Commercial support
@@ -120,7 +120,7 @@ info@django-cms.org.
 django CMS Association
 **********************
 
-The django CMS Association is a non-profit organization that was founded in 2020 with the goal to drive the success of django CMS, by increasing customer happiness, market share and open-source contributions. We provide infrastructure and guidance for the django CMS project. 
+The django CMS Association is a non-profit organization that was founded in 2020 with the goal to drive the success of django CMS, by increasing customer happiness, market share and open-source contributions. We provide infrastructure and guidance for the django CMS project.
 
 The non-profit django CMS Association is dependent on donations to fulfill its purpose. The best way to donate is to become a member of the association and pay membership fees. The funding will be funneled back into core development and community projects.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -37,7 +37,9 @@
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
-    'sphinxcontrib.spelling'
+    'sphinxcontrib.spelling',
+    "sphinx_copybutton",
+    "sphinxext.opengraph",
 ]
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3/', None),
@@ -61,8 +63,8 @@
 
 current_year = datetime.datetime.now().year
 # General information about the project.
-project = u'django cms'
-copyright = u'2009-{}, Divio AG and contributors'.format(current_year)
+project = 'django cms'
+copyright = '2009-{}, django CMS Association and contributors'.format(current_year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -129,55 +131,17 @@
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 try:
-    import divio_docs_theme
-    html_theme = 'divio_docs_theme'
-    html_theme_path = [divio_docs_theme.get_html_theme_path()]
+    import furo
+
+    html_theme = 'furo'
     html_theme_options = {
-        'show_cloud_banner': True,
-        'cloud_banner_markup': """
-            <div class="divio-cloud">
-                <span class="divio-cloud-caption">The django CMS Association</span>
-                <p>The django CMS Association is a non-profit organisation that funds and
-                steers the development of django CMS, and nurtures its world-wide
-                community of developers and users.</p>
-                <a class="btn-neutral divio-cloud-btn" target="_blank" href="https://www.django-cms.org/en/about-us/">Join us</a>
-            </div>
-        """,
+        "navigation_with_keys": True,
     }
-except:
+except ImportError:
     html_theme = 'default'
 
-
 show_cloud_banner = True
 
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme = 'default'
-
-# 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.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# 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 (within the static path) to use as 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".
@@ -233,8 +197,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'djangocms.tex', u'django cms Documentation',
-     u'Divio AG and contributors', 'manual'),
+    ('index', 'djangocms.tex', 'django cms Documentation',
+     'django CMS Association and contributors', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top

diff --git a/docs/contributing/development-policies.rst b/docs/contributing/development-policies.rst
@@ -13,7 +13,7 @@ Reporting security issues
 .. ATTENTION::
 
     If you think you have discovered a security issue in our code, please report
-    it **privately**, by emailing us at `security@divio.com <security@divio.com>`_.
+    it **privately**, by emailing us at `security@django-cms.org <security@django-cms.org>`_.
 
     Please **do not** raise it in any public forum until we have had a
     chance to deal with it.

diff --git a/docs/contributing/management.rst b/docs/contributing/management.rst
@@ -20,7 +20,7 @@ Raising an issue
 .. ATTENTION::
 
     If you think you have discovered a security issue in our code, please report
-    it **privately**, by emailing us at `security@divio.com <security@divio.com>`_.
+    it **privately**, by emailing us at `security@django-cms.org <security@django-cms.org>`_.
 
     Please **do not** raise it in any public forum until we have had a
     chance to deal with it.

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,10 +1,12 @@
 MarkupSafe==0.23
 Pygments==2.0.2
-sphinx
+furo
+Sphinx>4
+sphinx-copybutton
+sphinxext-opengraph
 sphinxcontrib-spelling
 pyenchant==3.0.1
 sphinx-autobuild
-divio-docs-theme
 datetime
 coverage
 django-cms
diff --git a/test_requirements/requirements_base.txt b/test_requirements/requirements_base.txt
@@ -12,8 +12,6 @@ https://github.com/divio/djangocms-text-ckeditor/archive/master.zip
 https://github.com/ojii/django-better-test/archive/8aa2407d097fe3789b74682f0e6bd7d15d449416.zip#egg=django-better-test
 https://github.com/ojii/django-app-manage/archive/65da18ef234a4e985710c2c0ec760023695b40fe.zip#egg=django-app-manage
 iptools
-sphinx==1.8.5
-sphinxcontrib-spelling<7.0.0 # restriction for py35 tests
 # required to run the server for integration tests
 django-app-helper
 mock>=2.0.0