From 381600911a197a129f2c1047dac91b0c5dd0c8e4 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 15 Sep 2020 18:47:15 -0400 Subject: [PATCH 1/6] moved doc -> docs --- {doc => docs}/Makefile | 0 {doc => docs}/conf.py | 0 {doc => docs}/index.rst | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/conf.py (100%) rename {doc => docs}/index.rst (100%) diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/conf.py b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/index.rst b/docs/index.rst similarity index 100% rename from doc/index.rst rename to docs/index.rst From e63193ed23172c2aa6a24de88de89d59a92c7831 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 15 Sep 2020 18:58:13 -0400 Subject: [PATCH 2/6] using ska-theme --- docs/conf.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 16bb0bc..66bfb3b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -97,7 +97,12 @@ # 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', +} # 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 From 71fb67e021c37f7abe7b1fc78ee615ebe9fd4e4a Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 15 Sep 2020 19:03:57 -0400 Subject: [PATCH 3/6] using ska-theme (fixup) --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 66bfb3b..7b01916 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -99,9 +99,9 @@ # a list of builtin themes. html_theme = 'bootstrap-ska' html_theme_options = { -logotext1: 'Ska!' , -logotext2: 'Ska', -logotext3: '.Shell', + 'logotext1': 'Ska!' , + 'logotext2': 'Ska', + 'logotext3': '.Shell', } # Theme options are theme-specific and customize the look and feel of a theme From 0f736dee345d2244e58e341f0384f9e00ebb441a Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 22 Sep 2020 17:19:36 -0400 Subject: [PATCH 4/6] added link to tool_doc page on cxc --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 7b01916..c377c41 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,6 +102,9 @@ '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 From 445fa3ce8c79e7eba21d156317a680e17a877046 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 22 Sep 2020 18:15:15 -0400 Subject: [PATCH 5/6] remove private namesfrom documentation --- docs/index.rst | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 99522f5..7cb169b 100644 --- a/docs/index.rst +++ b/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 ------------ From 848ad84ed5f066b551df5e7e1d46c15737af7f8f Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 29 Sep 2020 16:23:42 -0400 Subject: [PATCH 6/6] added workflow for docs --- .github/workflows/docs.yml | 49 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..0af5079 --- /dev/null +++ b/.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 }}