Skip to content

Commit

Permalink
Merge pull request #76 from TYPO3-Documentation/develop
Browse files Browse the repository at this point in the history
Merge branch 'develop' with changes for v4.2.0
  • Loading branch information
marble authored May 8, 2020
2 parents b4f2f2b + 68caa5b commit 726c1ff
Show file tree
Hide file tree
Showing 33 changed files with 1,350 additions and 898 deletions.
1 change: 1 addition & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ jobs:
node-version: "12.x"
- run: yarn install
- run: yarn frontend
- run: git status
- name: Assert clean working tree
run: git status | grep -q "nothing to commit, working tree clean"

Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
.idea
.ruby-version
.tox
/.conda-*
/.venv
/Pipfile*
/yarn-error.log
bower_components/
Expand Down
44 changes: 44 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,53 @@ History
Next release
============

...


4.2.0 (2020-05-08)
==================

Overview

#. If used with Sphinx extension `sphinxcontrib-gitloginfo
<https://github.com/TYPO3-Documentation/sphinxcontrib-gitloginfo/>`_ meta tags
with the 'last modified' date may now be added to the page html head section.
A 'Last updated' line can be shown in the footer with a link to the latest
commit.

#. For search result pages a link will appear to deselect hightlighting of
search text hits.

#. The intra page menu is now appended to the left menu column of the page.

#. The logo is now defineable in the theme configuration file `theme.conf`.

Some commits:

* d5cc051 [BUGFIX] Supply missing options in theme.conf to remove warnings
about non existing theme options
* a69e91b [FEATURE] Always show table of contents {{ toc }} to get back
"the third level" in the page menu
* e5f8b9c [FEATURE] Add date_last_modified and commit_url to footer
* 14c3f6a Update whitespace control in html templates to further beautify the
indentation of generated html
* 4da72be [FEATURE] Add last_updated_isoformat to meta data in html head
* e1061a2 [TASK] Update docsearch meta tags
* a6605e0 [FEATURE] Make logo defineable in theme.conf
* 9b25042, 54d580e Improve page template "layout.html"
* cfb7081 Update documentation
* 5f8cd43 Upgrade Javascript packages
* cbeac0c Have link "Hide Search Matches" appear on a page with the search
result to turn off the highlighting of the hits of the searched text


4.1.3 (2020-02-25)
==================

* Update documentation
* Have {{ theme_version }} in page context


4.1.2 (2020-02-25)
==================

Expand Down
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst
include USAGE.rst

recursive-include sphinx_typo3_theme *.*
recursive-exclude sphinx_typo3_theme .*.swp
23 changes: 23 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,15 @@ can be uploaded to PyPi run::

.. _venv: https://docs.python.org/3/library/venv.html

Grunt
=====

More commands are available by means of `grunt`. Run::

grunt --help

and check the `gruntfile.js`.


Theme stress test
=================
Expand All @@ -79,3 +88,17 @@ check the rendering.
.. _t3SphinxThemeRtdDemoDocs: https://docs.typo3.org/m/typo3/demo-t3SphinxThemeRtd/master/en-us/
.. _sphinx_typo3_theme: https://github.com/typo3-documentation/sphinx_typo3_theme


Javascript package management
=============================

Use `yarn` for package management.

To upgrade a Javascript package to a newer version use the following. This
keeps `package.json` and `yarn.lock` in sync as BOTH will be modified:

.. code-block:: shell
# ATTENTION: Select only those with reasonable version numbers.
# Be very careful if the MAJOR number would change
yarn upgrade-interactive --latest
22 changes: 11 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@
"private": true,
"dependencies": {},
"devDependencies": {
"@fortawesome/fontawesome-free": "^5.12.0",
"@fortawesome/fontawesome-free": "^5.13.0",
"TYPO3CMS-Guide-HowToDocument": "github:TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument",
"autocompleter": "^6.0.1",
"autocompleter": "^6.0.3",
"bootstrap": "^4.4.1",
"connect-livereload": "^0.6.1",
"grunt": "^1.0.4",
"grunt": "^1.1.0",
"grunt-cli": "^1.3.2",
"grunt-contrib-clean": "2.0.0",
"grunt-contrib-copy": "1.0.0",
"grunt-contrib-uglify": "^4.0.1",
"grunt-contrib-watch": "^1.1.0",
"grunt-exec": "^3.0.0",
"grunt-sass": "^3.1.0",
"grunt-stylelint": "^0.13.0",
"http-server": "^0.12.1",
"jquery": "^3.4.1",
"modernizr": "^3.8.0",
"node-sass": "^4.13.0",
"popper.js": "^1.16.0",
"stylelint": "^12.0.1",
"underscore": "^1.9.2"
"grunt-stylelint": "^0.15.0",
"http-server": "^0.12.3",
"jquery": "^3.5.0",
"modernizr": "^3.11.0",
"node-sass": "^4.14.0",
"popper.js": "^1.16.1",
"stylelint": "^13.3.3",
"underscore": "^1.10.2"
},
"scripts": {
"watch": "grunt watch",
Expand Down
84 changes: 49 additions & 35 deletions sphinx_typo3_theme/footer.html
Original file line number Diff line number Diff line change
@@ -1,64 +1,78 @@
{%- block footer -%}
<footer>
<div class="frame frame-ruler-before frame-background-dark">
<div class="frame-container">
<div class="frame-inner">

{%- if theme_docstypo3org -%}
{%- if theme_docstypo3org %}
{%-
if theme_project_home
or theme_project_contact
or theme_project_discussions
or theme_project_issues
or theme_project_repository
-%}
%}
<ul class="footer-simplemenu">
{%- if theme_project_home -%}
{%- if theme_project_home %}
<li><a href="{{ theme_project_home|e }}" title="Home"><span>Home</span></a></li>
{%- endif -%}
{%- endif %}
{%- if theme_project_contact -%}
<li><a href="{{ theme_project_contact|e }}" title="Contact"><span>Contact</span></a></li>
{%- endif -%}
{%- if theme_project_discussions -%}
{%- endif %}
{%- if theme_project_discussions %}
<li><a href="{{ theme_project_discussions|e }}" title="Discussions"><span>Discussions</span></a></li>
{%- endif -%}
{%- if theme_project_issues -%}
{%- endif %}
{%- if theme_project_issues %}
<li><a href="{{ theme_project_issues|e }}" title="Issues"><span>Issues</span></a></li>
{%- endif -%}
{%- if theme_project_repository -%}
{%- endif %}
{%- if theme_project_repository %}
<li><a href="{{ theme_project_repository|e }}" title="Repository"><span>Repository</span></a></li>
{%- endif -%}
{%- endif %}
</ul>
{%- endif -%}
{%- endif -%}

{%- endif %}
{%- endif %}
<div class="footer-additional">
{%- if theme_show_last_updated and last_updated -%}
<p class="text-center">Last rendered on {{ last_updated }}</p>
{%- endif -%}
<p class="text-center"><a href="https://github.com/TYPO3-Documentation/sphinx_typo3_theme" rel="nofollow" target="_blank">TYPO3 Theme {{ theme_version }}</a></p>
{%- if theme_show_last_modified and t3ctx.last_modified %}
{%- if t3ctx.commit_url %}
<p class="text-center">
Last updated: <a href="{{ t3ctx.commit_url|e }}" rel="nofollow" target="_blank" title="Last commit">
{{ t3ctx.last_modified|e }}
</a>
</p>
{%- else %}
<p class="text-center">Last updated: {{ t3ctx.last_modified|e }}</p>
{%- endif %}
{%- endif %}
{%- if theme_show_last_updated and last_updated %}
<p class="text-center">Last rendered: {{ last_updated|e }}</p>
{%- endif %}
<p class="text-center">
<a href="https://github.com/TYPO3-Documentation/sphinx_typo3_theme" rel="nofollow" target="_blank">
TYPO3 Theme {{ theme_version|e }}
</a>
</p>
</div>

<div class="footer-meta">
{%- if theme_show_copyright -%}
<div class="footer-meta-copyright">
{%- if hasdoc('Copyright') -%}
<a href="{{ pathto('Copyright') }}">&copy; Copyright {{ copyright }}</a>
{%- elif hasdoc('copyright') -%}
<a href="{{ pathto('copyright') }}">&copy; Copyright {{ copyright }}</a>
{%- else -%}
&copy; Copyright {{ copyright }}
{%- endif -%}
</div>
{%- if theme_show_copyright %}
<div class="footer-meta-copyright">
{%- if hasdoc('Copyright') %}
<a href="{{ pathto('Copyright') }}">&copy; Copyright {{ copyright }}</a>
{%- elif hasdoc('copyright') %}
<a href="{{ pathto('copyright') }}">&copy; Copyright {{ copyright }}</a>
{%- else %}
&copy; Copyright {{ copyright }}
{%- endif %}
</div>
{%- endif %}
{% if theme_docstypo3org -%}
<ul class="footer-meta-navigation">
<li><a href="https://typo3.org/legal-notice" rel="nofollow" target="_blank" title="Legal Notice">Legal Notice</a></li>
<li><a href="https://typo3.org/privacy-policy" rel="nofollow" target="_blank" title="Privacy Policy">Privacy Policy</a></li>
</ul>
{%- if theme_docstypo3org %}
<ul class="footer-meta-navigation">
<li><a href="https://typo3.org/legal-notice" rel="nofollow" target="_blank" title="Legal Notice">Legal Notice</a></li>
<li><a href="https://typo3.org/privacy-policy" rel="nofollow" target="_blank" title="Privacy Policy">Privacy Policy</a></li>
</ul>
{%- endif %}
</div>

</div>
</div>
</div>
</footer>
{%- endblock %}
Loading

0 comments on commit 726c1ff

Please sign in to comment.