Merge pull request #24 from ProperDocs/nothemes

Split out the themes into separate packages, NOT installed by default

Author: oprypin

.gitattributes

@@ -1,10 +1,10 @@
 properdocs/contrib/search/lunr-language/** linguist-vendored
-properdocs/themes/mkdocs/js/** linguist-vendored
-properdocs/themes/mkdocs/js/base.js linguist-vendored=false
-properdocs/themes/mkdocs/css/** linguist-vendored
-properdocs/themes/mkdocs/css/base.css linguist-vendored=false
-properdocs/themes/readthedocs/js/** linguist-vendored
-properdocs/themes/readthedocs/js/theme.js linguist-vendored=false
-properdocs/themes/readthedocs/css/** linguist-vendored
-properdocs/themes/readthedocs/css/theme_extra.css linguist-vendored=false
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/** linguist-vendored
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/base.js linguist-vendored=false
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/css/** linguist-vendored
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/css/base.css linguist-vendored=false
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/** linguist-vendored
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/theme.js linguist-vendored=false
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/css/** linguist-vendored
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/css/theme_extra.css linguist-vendored=false
 docs/img/plugin-events.svg linguist-generated

.github/workflows/ci.yml

@@ -118,7 +118,7 @@ jobs:
       - name: Check packaged files
         shell: bash -e -x {0}
         run: |
-          expected_wheel=(-eproperdocs/{templates/sitemap.xml,config/base.py,py.typed,contrib/search/lunr-language/lunr.nl.js,themes/{mkdocs,readthedocs}/{base.html,locales/{de,es}/LC_MESSAGES/messages.mo}})
-          expected_sdist=("${expected_wheel[@]}" -e{pyproject.toml,hatch_build.py})
+          expected_wheel=(-eproperdocs/{templates/sitemap.xml,config/base.py,py.typed,contrib/search/lunr-language/lunr.nl.js})
+          expected_sdist=("${expected_wheel[@]}" -epyproject.toml)
           test "$(tar -ztf dist/properdocs-*.tar.gz | grep -F "${expected_sdist[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_sdist[@]}"
           test "$(unzip -l dist/properdocs-*any.whl | grep -F "${expected_wheel[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_wheel[@]}"

.jshintignore

@@ -1,9 +1,9 @@
 properdocs/themes/**/js/jquery-**.min.js
-properdocs/themes/mkdocs/js/highlight.pack.js
-properdocs/themes/mkdocs/js/bootstrap.bundle.min.js
-properdocs/themes/mkdocs/js/modernizr-**.min.js
-properdocs/themes/readthedocs/js/theme.js
-properdocs/themes/readthedocs/js/html5shiv.min.js
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/highlight.pack.js
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/bootstrap.bundle.min.js
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/modernizr-**.min.js
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/theme.js
+packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/html5shiv.min.js
 properdocs/contrib/search/templates/search/lunr.js
 properdocs/contrib/search/lunr-language/lunr.**.js
 properdocs/contrib/search/lunr-language/tinyseg.js

CONTRIBUTING.md

@@ -159,8 +159,12 @@ updated by running the `extract_messages` command. To update the
 `pot` file for both built-in themes, run these commands:
 
 ```bash
-pybabel extract --project=ProperDocs --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file properdocs/themes/babel.cfg --output-file properdocs/themes/mkdocs/messages.pot properdocs/themes/mkdocs
-pybabel extract --project=ProperDocs --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file properdocs/themes/babel.cfg --output-file properdocs/themes/readthedocs/messages.pot properdocs/themes/readthedocs
+(cd packages/properdocs-theme-mkdocs/ && \
+pybabel extract --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file babel.cfg --output-file properdocs_theme_mkdocs/messages.pot properdocs_theme_mkdocs
+)
+(cd packages/properdocs-theme-readthedocs/ && \
+pybabel extract --copyright-holder=ProperDocs --msgid-bugs-address='https://github.com/properdocs/properdocs/issues' --no-wrap --version="$(hatch version)" --mapping-file babel.cfg --output-file properdocs_theme_readthedocs/messages.pot properdocs_theme_readthedocs
+)
 ```
 
 The updated `pot` file should be included in a PR with the updated template.

docs/dev-guide/translations.md

@@ -104,14 +104,14 @@ In particular, the way to know that the `pt` language should be disambiguated as
 So, if we pick `es` (Spanish) as our example language code, to add a translation for it to both built-in themes, run these commands:
 
 ```bash
-pybabel init --input-file properdocs/themes/mkdocs/messages.pot --output-dir properdocs/themes/mkdocs/locales -l es
-pybabel init --input-file properdocs/themes/readthedocs/messages.pot --output-dir properdocs/themes/readthedocs/locales -l es
+pybabel init --input-file packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/messages.pot --output-dir packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/locales -l es
+pybabel init --input-file packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/messages.pot --output-dir packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/locales -l es
 ```
 
 The above command will create a file structure as follows:
 
 ```text
-properdocs/themes/mkdocs/locales
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/locales
 ├── es
 │   └── LC_MESSAGES
 │       └── messages.po
@@ -141,8 +141,8 @@ for.
 To update the `fr` translation catalog of both built-in themes, use the following commands:
 
 ```bash
-pybabel update --ignore-obsolete --input-file properdocs/themes/mkdocs/messages.pot --output-dir properdocs/themes/mkdocs/locales -l fr
-pybabel update --ignore-obsolete --input-file properdocs/themes/readthedocs/messages.pot --output-dir properdocs/themes/readthedocs/locales -l fr
+pybabel update --ignore-obsolete --input-file packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/messages.pot --output-dir packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/locales -l fr
+pybabel update --ignore-obsolete --input-file packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/messages.pot --output-dir packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/locales -l fr
 ```
 
 You can now move on to the next step and [add a translation] for every updated
@@ -174,14 +174,14 @@ files of your theme into `messages.mo` files. The following commands will compil
 the `es` translation for both built-in themes:
 
 ```bash
-pybabel compile --statistics --directory properdocs/themes/mkdocs/locales -l es
-pybabel compile --statistics --directory properdocs/themes/readthedocs/locales -l es
+pybabel compile --statistics --directory packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/locales -l es
+pybabel compile --statistics --directory packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/locales -l es
 ```
 
 The above command results in the following file structure:
 
 ```text
-properdocs/themes/mkdocs/locales
+packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/locales
 ├── es
 │   └── LC_MESSAGES
 │       ├── messages.mo

docs/user-guide/choosing-your-theme.md

@@ -126,7 +126,7 @@ supports the following options:
     The following locales are supported by this theme:
 
     * `en`: English (default)
-    * (see the list of existing directories `properdocs/themes/mkdocs/locales/*/`)
+    * (see the list of existing directories `packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/locales/*/`)
 
     See the guide on [localizing your theme] for more information.
 
@@ -203,7 +203,7 @@ theme supports the following options:
     The following locales are supported by this theme:
 
     * `en`: English (default)
-    * (see the list of existing directories `properdocs/themes/readthedocs/locales/*/`)
+    * (see the list of existing directories `packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/locales/*/`)
 
     See the guide on [localizing your theme] for more information.
 

docs/user-guide/customizing-your-theme.md

@@ -219,7 +219,7 @@ any additional CSS files included in the `custom_dir`.
 [custom_dir]: ./configuration.md#custom_dir
 [name]: ./configuration.md#name
 [mkdocs]: ./choosing-your-theme.md#mkdocs
-[browse source]: https://github.com/properdocs/properdocs/tree/master/properdocs/themes/mkdocs
+[browse source]: https://github.com/properdocs/properdocs/tree/master/packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs
 [Template Variables]: ../dev-guide/themes.md#template-variables
 [Jinja documentation]: https://jinja.palletsprojects.com/en/latest/templates/#template-inheritance
 [super block]: https://jinja.palletsprojects.com/en/latest/templates/#super-blocks

packages/properdocs-theme-mkdocs/LICENSE

@@ -0,0 +1,26 @@
+Copyright © 2014-present, Tom Christie. All rights reserved.
+
+Redistribution and use in source and binary forms, with or
+without modification, are permitted provided that the following
+conditions are met:
+
+Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in
+the documentation and/or other materials provided with the
+distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

properdocs/themes/babel.cfg …ckages/properdocs-theme-mkdocs/babel.cfgproperdocs/themes/babel.cfg renamed to packages/properdocs-theme-mkdocs/babel.cfg properdocs/themes/babel.cfg renamed to packages/properdocs-theme-mkdocs/babel.cfg

@@ -7,8 +7,7 @@ class CustomBuildHook(BuildHookInterface):
     def initialize(self, version, build_data):
         from babel.messages.frontend import compile_catalog
 
-        for theme in 'mkdocs', 'readthedocs':
-            cmd = compile_catalog()
-            cmd.directory = os.path.join('properdocs', 'themes', theme, 'locales')
-            cmd.finalize_options()
-            cmd.run()
+        cmd = compile_catalog()
+        cmd.directory = os.path.join('properdocs_theme_mkdocs', 'locales')
+        cmd.finalize_options()
+        cmd.run()