Crafter CMS Docs theme for Sphinx Doc
Project description
# Sphinx-Doc theme for Crafter CMS
This repo contains the necessary assets to develop and deploy the python package that powers the Crafter CMS
Sphinx Docs theme.
A Gulp-powered build helps local development without `make html` to view the every change, making it easier
to work on the front end of the theme. This system as the following features:
- Handlebars HTML templates with Panini
- Sass compilation and prefixing
- JavaScript module bundling with webpack
- Built-in BrowserSync server
- For production builds:
- CSS compression
- JavaScript compression
- Image compression
## Local Theme Development
### Prerequisites
To use this, you need:
- [NodeJS](https://nodejs.org/en/) (0.12 or greater)
- [Git](https://git-scm.com/)
- [Yarn](https://yarnpkg.com/en)
- Python, twine and pip
- Foundation cli: `yarn global add foundation-cli`
- Run `yarn` to initialize the project (FYI. this is the equivalent to `npm install` in the yarn world)
### Running the dev server
Run `foundation watch`
### Development
The above will start the dev server and watch for changes. The important files to get started and
understanding are `src/layouts/default.html` and `src/pages/index.html`. These two are the markup
that renders what you see as soon as you run the watch. Index is what contains the test content to
work on styling.
At `src/assets/*` you'll find the other important parts ([s]css, js, imgs).
As for the sphinx theme itself, see `src/sphinx`.
## Build
- Run `yarn crafter`. This will update the `craftercms_sphinx_theme` directory which is the python
package to be built and published to PyPI
- Run `python setup.py sdist` to create a "source distribution"
- This will create `dist/` and inside with a .tar.gz
- Run `python setup.py bdist_wheel --universal` to create a "universal wheel"
- This will create a .whl inside of `dist/` and a `build/`
- To upload project to PyPI — with twine:
- [Set up your account](https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi)
- If you haven't already, `pip install twine` & `pip install wheel`
- `twine upload dist/*`
- Visit [PyPI](https://pypi.python.org/pypi?%3Aaction=pkg_edit&name=craftercms-sphinx-theme) to manage the package
- Tada! Done.
#### Extra credit
https://packaging.python.org/tutorials/distributing-packages
This repo contains the necessary assets to develop and deploy the python package that powers the Crafter CMS
Sphinx Docs theme.
A Gulp-powered build helps local development without `make html` to view the every change, making it easier
to work on the front end of the theme. This system as the following features:
- Handlebars HTML templates with Panini
- Sass compilation and prefixing
- JavaScript module bundling with webpack
- Built-in BrowserSync server
- For production builds:
- CSS compression
- JavaScript compression
- Image compression
## Local Theme Development
### Prerequisites
To use this, you need:
- [NodeJS](https://nodejs.org/en/) (0.12 or greater)
- [Git](https://git-scm.com/)
- [Yarn](https://yarnpkg.com/en)
- Python, twine and pip
- Foundation cli: `yarn global add foundation-cli`
- Run `yarn` to initialize the project (FYI. this is the equivalent to `npm install` in the yarn world)
### Running the dev server
Run `foundation watch`
### Development
The above will start the dev server and watch for changes. The important files to get started and
understanding are `src/layouts/default.html` and `src/pages/index.html`. These two are the markup
that renders what you see as soon as you run the watch. Index is what contains the test content to
work on styling.
At `src/assets/*` you'll find the other important parts ([s]css, js, imgs).
As for the sphinx theme itself, see `src/sphinx`.
## Build
- Run `yarn crafter`. This will update the `craftercms_sphinx_theme` directory which is the python
package to be built and published to PyPI
- Run `python setup.py sdist` to create a "source distribution"
- This will create `dist/` and inside with a .tar.gz
- Run `python setup.py bdist_wheel --universal` to create a "universal wheel"
- This will create a .whl inside of `dist/` and a `build/`
- To upload project to PyPI — with twine:
- [Set up your account](https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi)
- If you haven't already, `pip install twine` & `pip install wheel`
- `twine upload dist/*`
- Visit [PyPI](https://pypi.python.org/pypi?%3Aaction=pkg_edit&name=craftercms-sphinx-theme) to manage the package
- Tada! Done.
#### Extra credit
https://packaging.python.org/tutorials/distributing-packages
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for craftercms_sphinx_theme-1.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 158fff1f077febfebe269f9aa83895925b6ee2a38541504534a956154525db8f |
|
MD5 | 27e48bc7cb8704efd4fc3255757bf18e |
|
BLAKE2b-256 | 44d6eebd35a199c625f20aa92b4819156d512974075a40eb534adbe23ec43976 |
Close
Hashes for craftercms_sphinx_theme-1.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4197cc03d71e3c952ce9259df5525c34c37268f5cb6aa45ad068bb3cb95d7da |
|
MD5 | 588f178cd7b90de0393a23568e62847e |
|
BLAKE2b-256 | 7a6532adf1c9a316795ecd5b0ea826b01d57f623c7d3b8cfc6c78ab0002028da |