Skip to content

Commit

Permalink
docs, metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidLeoni committed Sep 24, 2020
1 parent 592043c commit ef4b7e2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,8 @@ Sphinx docs build using the same Docker and environment of ReadTheDocs server.

The approach is a bit heavyweight (RTD docker alone is at least 5 gigas), so you may well want to try [other fine solutions for Sphinx](https://github.com/ammaraskar/sphinx-action)

## Technical description

Tries to mimic RTD build process in [entrypoint.sh](entrypoint.sh) using RTD Dockerfile Ubuntu configuration, and if used as Github Action, Sphinx `_build` output is made available in `/github/workspace` which is shared by steps in a Github Action job.
**DETAILS**: Tries to mimic RTD build process in [entrypoint.sh](entrypoint.sh) using RTD Dockerfile Ubuntu configuration, and if used as Github Action, Sphinx `_build` output is made available in `/github/workspace` which is shared by steps in a Github Action job.

Dockerfile is also usable locally for your own builds.

For an example usage, see [Jupman](https://github.com/DavidLeoni/jupman/blob/master/.github/workflows/main.yml)

6 changes: 5 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# action.yml
name: 'Sphinx Docs build in Github Actions with ReadTheDocs Docker'
name: 'Sphinx Docs build with ReadTheDocs Docker'
author: 'David Leoni'
description: 'Reproduces ReadTheDocs build in Github Actions (to some degree). Also useful for local build.'
branding:
icon: 'book-open'
color: 'green'
inputs:
RTD_PRJ_NAME:
description: |
Expand Down

0 comments on commit ef4b7e2

Please sign in to comment.