A Stacks application for generating static HTML pages.
Project description
# stacks-page
A Stacks application for generating static HTML pages. Stacks is an in-development, open-source initiative of WGBH (http://www.wgbh.org/)
## Dependencies
* `django-versatileimagefield` >= 1.0.2
* `django-textplusstuff` >= 0.4
## Release Notes
### 0.1.1
* Including templates in pypi release.
### 0.1
* Initial open source release
## Required Settings
### `STACKSPAGE_STATIC_PUBLISH_SERVERS`
Used to define servers where pages can be published to.
```
STACKSPAGE_STATIC_PUBLISH_SERVERS = {
'staging': {
'server': 'user@staging_server',
'webroot_folder': '/absolute/path/to/webroot/on/server',
'base_url': 'http://staging.somesite.com'
},
'production': {
'server': 'user@prod_server',
'webroot_folder': '/absolute/path/to/webroot/on/server',
'base_url': 'http://www.somesite.com'
}
}
```
TODO: Document 'path_processor'!
### `STACKSPAGE_BUILD_DIRECTORY`
A path on local disc where statically generated StacksPage instances
should be saved-to.
```
STACKSPAGE_BUILD_DIRECTORY = '/path/to/folder'
```
For local development, you'll probably want to set this dynamically. The following code will create a directory named `stackspage_build` at the same level as your project's settings file:
```
import os
BASE_DIR = os.path.dirname(os.path.dirname(__file__)
STACKSPAGE_BUILD_DIRECTORY = os.path.join(BASE_DIR, 'stackspage_build')
```
### `STACKSPAGE_URL_PREFIX`
The path your Stacks application is running from, defaults to '/'.
A Stacks application for generating static HTML pages. Stacks is an in-development, open-source initiative of WGBH (http://www.wgbh.org/)
## Dependencies
* `django-versatileimagefield` >= 1.0.2
* `django-textplusstuff` >= 0.4
## Release Notes
### 0.1.1
* Including templates in pypi release.
### 0.1
* Initial open source release
## Required Settings
### `STACKSPAGE_STATIC_PUBLISH_SERVERS`
Used to define servers where pages can be published to.
```
STACKSPAGE_STATIC_PUBLISH_SERVERS = {
'staging': {
'server': 'user@staging_server',
'webroot_folder': '/absolute/path/to/webroot/on/server',
'base_url': 'http://staging.somesite.com'
},
'production': {
'server': 'user@prod_server',
'webroot_folder': '/absolute/path/to/webroot/on/server',
'base_url': 'http://www.somesite.com'
}
}
```
TODO: Document 'path_processor'!
### `STACKSPAGE_BUILD_DIRECTORY`
A path on local disc where statically generated StacksPage instances
should be saved-to.
```
STACKSPAGE_BUILD_DIRECTORY = '/path/to/folder'
```
For local development, you'll probably want to set this dynamically. The following code will create a directory named `stackspage_build` at the same level as your project's settings file:
```
import os
BASE_DIR = os.path.dirname(os.path.dirname(__file__)
STACKSPAGE_BUILD_DIRECTORY = os.path.join(BASE_DIR, 'stackspage_build')
```
### `STACKSPAGE_URL_PREFIX`
The path your Stacks application is running from, defaults to '/'.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
stacks-page-0.1.1.tar.gz
(12.6 kB
view hashes)
Built Distribution
Close
Hashes for stacks_page-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47844f6787e6deef9fe4c6975bb4dca680f5a239e4583614a77c8a5860a3452a |
|
MD5 | 611df043cb7874a69c8a5a85cda8eb47 |
|
BLAKE2b-256 | 89e2c4f33e15396ca490089911a646d47c9b137e3ff8318eabe8166d041baa17 |