Skip to content

Commit

Permalink
[Resolves #1327] Remove docs build and publish (#1407)
Browse files Browse the repository at this point in the history
The building and hosting of Sceptre docs have been offloaded to readthedocs.io[1] in PR #1404 therefore the CI for this project no longer needs to build and publish docs to github pages at https://github.com/Sceptre/sceptre.github.io

depends on #1404

[1] https://sceptre.readthedocs.io/en/latest/
  • Loading branch information
zaro0508 committed Jan 13, 2024
1 parent 5358748 commit d8c8f36
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 263 deletions.
31 changes: 0 additions & 31 deletions .circleci/README.md

This file was deleted.

14 changes: 0 additions & 14 deletions .circleci/add-known-hosts.sh

This file was deleted.

43 changes: 0 additions & 43 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,6 @@ executors:
docker:
- image: circleci/buildpack-deps:stretch

aliases:
- &docs-job
executor: python/default
steps:
- checkout
- add_ssh_keys:
fingerprints:
- "80:24:c0:40:28:36:f1:80:7f:fd:15:c3:09:cf:86:fc"
- attach_workspace:
at: /home/circleci
- python/install-packages:
pkg-manager: poetry
args: --all-extras
- run:
name: Build and deploy docs
command: |
poetry run ./.circleci/add-known-hosts.sh
poetry run ./.circleci/github-pages.sh
environment:
REPOSITORY_PATH: /home/circleci/docs
DEPLOYMENT_GIT_SSH: git@github.com:Sceptre/sceptre.github.io.git

jobs:
build:
executor: python/default
Expand Down Expand Up @@ -146,10 +124,6 @@ jobs:
paths:
- ./image.tar

deploy-docs-branch: *docs-job

deploy-docs-tag: *docs-job

deploy-pypi-prod:
executor: python/default
steps:
Expand Down Expand Up @@ -236,14 +210,6 @@ workflows:
filters:
branches:
ignore: /^pull\/.*/
- deploy-docs-branch:
context: sceptre-core
requires:
- unit-tests
- integration-tests
filters:
branches:
ignore: /^pull\/.*/
- build-docker-image:
requires:
- unit-tests
Expand All @@ -268,15 +234,6 @@ workflows:
only: /^v([0-9]+)\.([0-9]+)\.([0-9]+)(?:([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$/
branches:
ignore: /.*/
- deploy-docs-tag:
context: sceptre-core
requires:
- deploy-pypi-prod
filters:
tags:
only: /^v([0-9]+)\.([0-9]+)\.([0-9]+)(?:([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$/
branches:
ignore: /.*/
- build-docker-image:
requires:
- deploy-pypi-prod
Expand Down
75 changes: 0 additions & 75 deletions .circleci/documentation-versions.py

This file was deleted.

99 changes: 0 additions & 99 deletions .circleci/github-pages.sh

This file was deleted.

10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Or to run a specific test in that file:
$ poetry run pytest -ssv <test-file>.py::<unit-test-class>::<test-case>
```

## Build documentation
## Documentation

Sceptre uses [Sphinx](https://www.sphinx-doc.org/en/master/) to generate
documentation in HTML format.
Expand All @@ -165,6 +165,14 @@ To build the documentation locally:

*Note*: The generated documentation files are in docs/_build/html

The CI for Sceptre docs have been offloaded to [readthedocs.org](https://readthedocs.org/).
It is managed by the [.readthedocs.yaml](.readthedocs.yaml) configuration file
which builds the docs on every change and publishes them to
[sceptre.readthedocs.io](https://sceptre.readthedocs.io).

The [docs.sceptre-project.org](https://docs.sceptre-project.org) domain is setup
to be the main website for Sceptre docs.

## Integration Tests

If you haven't setup your local environment or personal CircleCI account to run
Expand Down

0 comments on commit d8c8f36

Please sign in to comment.