Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unified documentation style #52

Merged
merged 3 commits into from
Sep 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Deploy Docs
on:
release:
types:
- created
repository_dispatch:
types:
- build-docs

jobs:
build-linux:
runs-on: head
name: Deploy Docs
steps:
- name: Fetch gh-pages
uses: actions/checkout@v2
with:
path: gh-pages
ref: gh-pages
- name: Fetch source
uses: actions/checkout@v2
with:
path: source
- name: clear
run: rm -fr gh-pages/docs/*
- name: build
run: |
eval "$(/export/jgonzale/github-workflows/miniconda3-shiny/bin/conda shell.bash hook)"
conda activate ska3-masters
mkdir -p _static
make html
working-directory: source/docs
env:
PYTHONPATH: ${{ github.workspace }}/source
GITHUB_API_TOKEN: ${{ secrets.CHANDRA_XRAY_TOKEN }}
- name: copy
run: cp -fr source/docs/_build/html/* gh-pages/docs
- name: Commit changes
uses: EndBug/add-and-commit@v4
with:
ref: "gh-pages"
cwd: "gh-pages"
author_name: Javier Gonzalez
author_email: javierggt@yahoo.com
message: "Deploy docs"
add: "docs"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10 changes: 9 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'bootstrap-astropy' # 'classic'
html_theme = 'bootstrap-ska'
html_theme_options = {
'logotext1': 'Ska! ', # white, semi-bold
'logotext2': 'Chandra', # orange, light
'logotext3': '.Time', # white, light
'homepage_url': 'https://cxc.cfa.harvard.edu/mta/ASPECT/tool_doc',
'homepage_text': 'ska',
'homepage_text_2': 'tools'
}

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down