Merge pull request #23 from sot/ska-theme

Unified documentation style

.github/workflows/docs.yml

@@ -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 }}

doc/conf.py → docs/conf.py

@@ -97,7 +97,15 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'bootstrap-ska'
+html_theme_options = {
+    'logotext1': 'Ska!' ,
+    'logotext2': 'Ska',
+    'logotext3': '.Shell',
+    '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

doc/index.rst → docs/index.rst

@@ -11,12 +11,6 @@ Welcome to Ska.Shell's documentation!
 Functions
 ----------
 
-.. autofunction:: _fix_paths
-
-.. autofunction:: _parse_keyvals
-
-.. autofunction:: _sendline_expect_func
-
 .. autofunction:: bash
 
 .. autofunction:: bash_shell
@@ -42,13 +36,6 @@ Classes
    :undoc-members:
 
 
-.. autoclass:: _NullFile
-   :show-inheritance:
-   :members:
-   :inherited-members:
-   :undoc-members:
-
-
 Exceptions
 ------------