Switch to entrypoint-based themes handling #829
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidbgk
suggested changes
Mar 27, 2017
docs/creating-theme.md
Outdated
| - reuses without image (`reuse.png`) | ||
| - territory without logo or flag (`territory.png`) | ||
|
|
||
| Then your free to add any static assets reuired by your theme |
docs/creating-theme.md
Outdated
| <link rel="shortcut icon" href="{{ theme_static('img/favicon.png') }}"> | ||
| {% endblock %} | ||
| ``` | ||
| You can reference static assets from you theme with the `theme_static` global function. |
docs/creating-theme.md
Outdated
| You can reference static assets from you theme with the `theme_static` global function. | ||
|
|
||
| !!! note | ||
| Don't forget to call `{{ super() }}` to includes the original block. |
docs/creating-theme.md
Outdated
|
|
||
| ### Hooks | ||
|
|
||
| You're theme can also customize some behavior be using hooks in you ``__init__.py``. |
There was a problem hiding this comment.
YouR + behaviors + bY + youR => Your theme can also customize some behaviors by using hooks in your ``__init__.py``.
docs/creating-theme.md
Outdated
| ### Hooks | ||
|
|
||
| You're theme can also customize some behavior be using hooks in you ``__init__.py``. | ||
| Currently there is 2 available hooks: |
| ## Publish and use | ||
|
|
||
| Once your theme is ready, you can publish it on [PyPI][] to share it to the world | ||
| (and notify us so we can be glad of your work). |
There was a problem hiding this comment.
and link to your theme from the documentation?
There was a problem hiding this comment.
I added a "Known themes" section with a note on contributions
CHANGELOG.md
Outdated
| @@ -8,6 +8,9 @@ | |||
| [Flask-Security-Fork](https://pypi.python.org/pypi/Flask-Security-Fork) | |||
| [#813](https://github.com/opendatateam/udata/pull/813) | |||
| - Ensure URLs are stripped [#823](https://github.com/opendatateam/udata/pull/823) | |||
| - Themes are now entrypoint-based [#829](https://github.com/opendatateam/udata/pull/829). | |||
| This is now documented, see [the related documention](https://udata.readthedocs.io/en/stable/creating-theme/) | |||
There was a problem hiding this comment.
now is used twice, I'd remove the second one.
docs/creating-theme.md
Outdated
| ### `setup.py` | ||
|
|
||
| The `setup.py` is a classic python `setup.py` file. | ||
| The only requirements is that you properly expose the udata theme packaging |
docs/creating-theme.md
Outdated
|
|
||
| ### Static assets | ||
|
|
||
| The `static` should contains at least 2 files: |
docs/creating-theme.md
Outdated
| The `static` should contains at least 2 files: | ||
|
|
||
| - `theme.css` which is loaded automatically on every page | ||
| - `admin.css` which is loaded automatically on on the amdin page |
There was a problem hiding this comment.
admin (typo on second occurrence)
|
@davidbgk Good to merge ? |
davidbgk
approved these changes
Mar 28, 2017
docs/creating-theme.md
Outdated
| - reuses without image (`reuse.png`) | ||
| - territory without logo or flag (`territory.png`) | ||
|
|
||
| Then your free to add any static assets required by your theme. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR switch to entrypoint-based themes handling as it offers many advantages:
There theming process has also been documented.