HTML landing page generator for LSST PDF documentation deployed from Git to LSST the Docs.
Project description
HTML landing page generator for LSST PDF documentation deployed from Git to LSST the Docs.
Installation
Lander works with Python 3.5 or above. You can install it from PyPI:
pip install lander
Run lander -h for command line help.
Usage
Basic usage
To create a landing page website, run lander with the local PDF file’s path:
lander --pdf <path>
The built PDF landing page site is available, by default, from the _build directory. View the site in a browser by running a Python web server:
cd _build && python -m http.server 8000 --bind 127.0.0.1
Get metadata from an lsstdoc document
With the --lsstdoc <tex path> argument, Lander will attempt to scrape metadata from the source of a lsstdoc-class LaTeX file, including:
abstract
authors
document handle
title
Note that Lander does not convert LaTeX commands to HTML. In these cases, the metadata needs to be added explicitly. We plan to address this in future releases.
See https://lsst-texmf.lsst.io for information about the lsstdoc class.
Get metadata from the Travis environment
If you’re running on Travis CI, set the --env=travis to get metadata from Travis’s environment variables:
$TRAVIS_COMMIT
$TRAVIS_BRANCH
$TRAVIS_TAG
$TRAVIS_REPO_SLUG
$TRAVIS_JOB_NUMBER
Overriding metadata
Lander tries to get as much metadata from the environment as possible, but sometimes this isn’t possible or usable. For example, Lander can’t (yet) convert LaTeX expressions into HTML. In this case you can explicitly set metadata with these flags (see lander -h for more information):
--abstract
--authors
--title
--handle (such as LDM-151)
--repo-url (such as https://github.com/lsst/ldm-151)
--repo-branch (such as master)
--date (such as 2017-05-22)
--docushare-url (prefer the multi-version form, https://ls.st/ldm-151*)
--authors should be a JSON-formatted array, even for a single author. For example:
--authors "[\"First Author\", \"Second Author\"]"
Distributing extra files from the landing page
To include ancillary files with the main PDF document, provide their file paths with the --extra-downloads path. These extra files are listed in the Downloads section of the landing page. The main PDF is always included first in this list.
--extra-downloads should be a JSON-formatted array, even for a single item. For example:
--extra-downloads "[\"demo.ipynb\"]"
Uploading to LSST the Docs
Lander works well with LSST the Docs. Lander can upload pages directly to LSST the Docs for you with these configurations:
--upload — provide this flag to indicate a build should be uploaded.
--ltd-product — Name of the product on LSST the Docs.
--keeper-url or $LTD_KEEPER_URL.
--keeper-user or $LTD_KEEPER_USER.
--keeper-password or $LTD_KEEPER_PASSWORD.
--aws-id or $LTD_AWS_ID.
--aws-secret or $LTD_AWS_SECRET.
Note: these are advanced configurations and are typically added to a CI configuration automatically or by a Documentation Engineer. Reach out to #dm-docs on Slack for help.
Development workflow
You need both Python 3.5+ and node.js to develop Lander.
Initial set up
Clone and install dependencies (use a Python virtual environment of your choice):
git clone https://github.com/lsst-sqre/lander cd lander npm install pip install -r requirements.txt python setup.py develop
Run Python tests and linting
We use pytest:
pytest
Build a test site
The default gulp workflow create website assets and generates a test website:
gulp
This gulp task runs a browsersync server and refreshes the page whenever CSS, JavaScript, or HTML assets change.
Only build assets
If you want to only build CSS, icon, and JavaScript assets, run this task:
gulp assets --env=deploy
This is how assets are built on CI for releases of Lander.
Developing CSS/Sass with squared
Lander uses squared for visual design. All Lander CSS should be committed to the squared repo so that LSST SQuaRE web projects share a common visual language.
To make it easier to write Sass in squared while developing landing pages in Lander, we recommend linking a clone of squared to Lander’s node_modules. Assuming you’re starting from the lander/ root directory:
git clone https://github.com/lsst-sqre/squared ../squared npm link ../squared
Some patterns:
If you’re working on a branch in squared, then update squared’s version in package.json to that branch. For example: "squared": "lsst-sqre/squared#tickets/DM-10503". This allows Travis to install the development version of squared when testing Lander. Remember to make a release of squared before releasing a new version of Lander, see below.
scss/app.scss in the lander repo imports Sass partials from squared and other packages (including inuitcss).
Release workflow
Update package.json with the released version of squared. Using tagged npm releases is preferred to GitHub branches to make builds of releases repeatable.
Create a signed tag: git tag -s 0.1.0 -m "v0.1.0". Use the PEP 440 schema.
Push the tag: git push --tags. This will automatically create a Lander release on PyPI.
Merge the development branch as necessary.
License
This project is open sourced under the MIT license. See LICENSE for 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
File details
Details for the file lander-0.1.0b4.tar.gz.
File metadata
- Download URL: lander-0.1.0b4.tar.gz
- Upload date:
- Size: 47.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 599ccd49bc04e565695fee25441223dba8298ad50c1b8d62a6edb9d7865df35b |
|
| MD5 | 89092e4f551f692a394e27c7abfed91d |
|
| BLAKE2b-256 | 5e17283282c34cb034192d3dce44ed7f277b858f0d874b8c7cfcaae4629f1735 |
File details
Details for the file lander-0.1.0b4-py3-none-any.whl.
File metadata
- Download URL: lander-0.1.0b4-py3-none-any.whl
- Upload date:
- Size: 16.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3b0bed8fa19d0f8fe272ebe0d2f3183aedc2d316c8378e4ee0344d739e99b9ad |
|
| MD5 | aa56e924d9a5cc84c705384ef4f64edc |
|
| BLAKE2b-256 | d37d99f211f9c3f174fc8b4bbce5e4b5b7a31aba889ca12c236f9e83e146540d |
