Skip to content

Commit

Permalink
Merge pull request #844 from parente/transifex
Browse files Browse the repository at this point in the history
Try RTD+Transifex workflow
  • Loading branch information
parente authored Apr 22, 2019
2 parents 58e2a02 + c6bee39 commit f646d2b
Show file tree
Hide file tree
Showing 14 changed files with 3,195 additions and 16 deletions.
6 changes: 4 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
dist: xenial
language: python
python:
- 3.6
- 3.7
sudo: required
services:
- docker
install:
- pip install --upgrade pip
- make dev-env
script:
- set -e
- make test/docs docs
- make docs
- make build-test-all DARGS="--build-arg TEST_ONLY_BUILD=1"
3 changes: 0 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,6 @@ dev-env: ## install libraries required to build docs and run tests
docs: ## build HTML documentation
make -C docs html

test/docs: ## check links in Sphinx documentation
make -C docs

test/%: ## run tests against a stack
@TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest test

Expand Down
27 changes: 27 additions & 0 deletions docs/.tx/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[main]
host = https://www.transifex.com

[jupyter-docker-stacks-1.using]
file_filter = locale/<lang>/LC_MESSAGES/using.po
source_file = _build/gettext/using.pot
source_lang = en
type = PO

[jupyter-docker-stacks-1.maintaining]
file_filter = locale/<lang>/LC_MESSAGES/maintaining.po
source_file = _build/gettext/maintaining.pot
source_lang = en
type = PO

[jupyter-docker-stacks-1.index]
file_filter = locale/<lang>/LC_MESSAGES/index.po
source_file = _build/gettext/index.pot
source_lang = en
type = PO

[jupyter-docker-stacks-1.contributing]
file_filter = locale/<lang>/LC_MESSAGES/contributing.po
source_file = _build/gettext/contributing.pot
source_lang = en
type = PO

11 changes: 8 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@

# General information about the project.
project = 'docker-stacks'
copyright = '2018, Project Jupyter'
copyright = '2018- Project Jupyter'
author = 'Project Jupyter'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -191,7 +191,12 @@
'Miscellaneous'),
]

# -- Extension configuration -------------------------------------------------
# -- Extension configuration ----------------------------------------------

# Anchors are often dynamic
linkcheck_anchors = False
linkcheck_anchors = False

# -- Translation ----------------------------------------------------------

gettext_uuid = True
locale_dirs = ['locale/']
2 changes: 1 addition & 1 deletion docs/contributing/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Thank you for contributing to the Jupyter Docker Stacks! We review pull requests
Please follow the process below to suggest a new feature for inclusion in one of the core stacks:

1. [Open a GitHub issue](https://github.com/jupyter/docker-stacks/issues) describing the feature you'd like to contribute.
2. Discuss with the maintainers whether the addition makes sense in [one of the core stacks](../using/selecting.html#Core-Stacks), as a [recipe in the documentation](recipes.html), as a [community stack](stacks.html), or as something else entirely.
2. Discuss with the maintainers whether the addition makes sense in [one of the core stacks](../using/selecting.md#Core-Stacks), as a [recipe in the documentation](recipes.md), as a [community stack](stacks.md), or as something else entirely.

## Selection Criteria

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/recipes.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# New Recipes

We welcome contributions of [recipes](../using/recipes.html), short examples of using, configuring, or extending the Docker Stacks, for inclusion in the documentation site. Follow the process below to add a new recipe:
We welcome contributions of [recipes](../using/recipes.md), short examples of using, configuring, or extending the Docker Stacks, for inclusion in the documentation site. Follow the process below to add a new recipe:

1. Open the `docs/using/recipes.md` source file.
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension``)
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension`)
3. Write the body of your recipe under the heading, including whatever command line, Dockerfile, links, etc. you need.
4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) (PR) with your changes. Maintainers will respond and work with you to address any formatting or content issues.
Loading

0 comments on commit f646d2b

Please sign in to comment.