Unverified Commit f2414a22 authored by Christine Kim's avatar Christine Kim Committed by GitHub
Browse files

Docs workflow test (#198) 

* Docs workflow test

* Update python versions and change conda env

* Updated readme and added dep to env.yml

* Add css config for footer placement
parent 98206cc3

.github/workflows/aws_doc_deploy.yml

0 → 100644
+48 −0
Original line number Diff line number Diff line 
name: aws-doc-deploy



on:

  workflow_run:

    workflows: ["Pull-Request-CI"]

    branches: [main]

    types: 

      - completed



jobs:

  deploy:

    if: ${{ github.event.workflow_run.conclusion == 'success' }}

    runs-on: ubuntu-latest

    defaults:

      run:

        shell: bash -el {0}

    steps:

      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9

        with:

          submodules: true

          fetch-depth: 0

      - uses: conda-incubator/setup-miniconda@3b0f2504dd76ef23b6d31f291f4913fb60ab5ff3

        with:

          miniconda-version: "latest"

          activate-environment: plio

          environment-file: environment_docs.yml

          auto-activate-base: false

          auto-update-conda: true



      - name: Check doc build environment

        run: |

          conda list



      - name: Build Docs

        run: |

          cd docs

          sphinx-build -b html . public

            

      - name: Set AWS credentials for upload

        uses: aws-actions/configure-aws-credentials@0e613a0980cbf65ed5b322eb7a1e075d28913a83

        with:

          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}

          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

          aws-region: us-west-2

      

      - name: Upload to S3

        working-directory: docs

        run: aws s3 sync --delete public s3://asc-public-docs/plio
 
 No newline at end of file

.github/workflows/continuous_integration.yml

+29 −4
Original line number Diff line number Diff line
@@ -3,10 +3,10 @@ name: Pull-Request-CI 
on:

  pull_request:

    branches:

      - master

      - main

  push:

    branches:

      - master

      - main



jobs:

  Build-and-Test:
@@ -15,7 +15,7 @@ jobs: 
      fail-fast: false

      matrix:

       os: [ubuntu-latest, macos-latest]

       python-version: ["3.6", "3.7", "3.8"]   

       python-version: ["3.8", "3.9", "3.10", "3.11"]   

    defaults:

      run:

        shell: bash -l {0}
@@ -30,7 +30,7 @@ jobs: 
          use-mamba: true

          channels: conda-forge, defaults

          channel-priority: strict

          activate-environment: autocnet

          activate-environment: plio

          environment-file: environment.yml

          python-version: ${{ matrix.python-version }}

      - name: Check build environment
@@ -49,3 +49,28 @@ jobs: 
          fail_ci_if_error: true

          verbose: true

        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8'



  Build-Docs:

    runs-on: ubuntu-latest

    defaults:

      run:

        shell: bash -el {0}

    steps:

      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9

        with:

          submodules: true

          fetch-depth: 0

      - uses: conda-incubator/setup-miniconda@3b0f2504dd76ef23b6d31f291f4913fb60ab5ff3

        with:

          miniconda-version: "latest"

          activate-environment: plio

          environment-file: environment_docs.yml

          auto-activate-base: false

          auto-update-conda: true

      - name: Check doc build environment

        run: |

          conda list

      - name: Build Docs

        run: |

          cd docs

          sphinx-build -b html . public

README.md

+23 −0
Original line number Diff line number Diff line
@@ -64,3 +64,26 @@ To install the development version: 
```

conda install -c usgs-astrogeology/label/dev plio

```



Building documentation

======================



Create the `plio` conda environment:



```

conda env create -f environment.yml

```



Activate the conda environment:



```

conda activate plio

```



Go into the `docs` directory and build the sphinx docs with:



```

sphinx-build -b html . public

```



This outputs the generated documentation into `docs/public` where you can open `public/index.html` in a browser to view PLIO docs locally. 
 No newline at end of file

docs/_templates/ganalytics_layout.html

deleted100644 → 0
+0 −221
Original line number Diff line number Diff line 
{%- block doctype -%}

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

{%- endblock %}

{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}

{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}



{%- macro relbar() %}

    <div class="related">

      <h3>{{ _('Navigation') }}</h3>

      <ul>

        {%- for rellink in rellinks %}

        <li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>

          <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}"

             {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>

          {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>

        {%- endfor %}

        {%- block rootrellink %}

        <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>

        {%- endblock %}

        {%- for parent in parents %}

          <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>

        {%- endfor %}

        {%- block relbaritems %} {% endblock %}

      </ul>

    </div>

{%- endmacro %}



{%- macro sidebar() %}

      {%- if not embedded %}{% if not theme_nosidebar|tobool %}

      <div class="sphinxsidebar">

        <div class="sphinxsidebarwrapper">

          {%- block sidebarlogo %}

          {%- if logo %}

            <p class="logo"><a href="{{ pathto(master_doc) }}">

              <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>

            </a></p>

          {%- endif %}

          {%- endblock %}

          {%- block sidebartoc %}

          {%- if display_toc %}

            <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>

            {{ toc }}

          {%- endif %}

          {%- endblock %}

          {%- block sidebarrel %}

          {%- if prev %}

            <h4>{{ _('Previous topic') }}</h4>

            <p class="topless"><a href="{{ prev.link|e }}"

                                  title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>

          {%- endif %}

          {%- if next %}

            <h4>{{ _('Next topic') }}</h4>

            <p class="topless"><a href="{{ next.link|e }}"

                                  title="{{ _('next chapter') }}">{{ next.title }}</a></p>

          {%- endif %}

          {%- endblock %}

          {%- block sidebarsourcelink %}

          {%- if show_source and has_source and sourcename %}

            <h3>{{ _('This Page') }}</h3>

            <ul class="this-page-menu">

              <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"

                     rel="nofollow">{{ _('Show Source') }}</a></li>

            </ul>

          {%- endif %}

          {%- endblock %}

          {%- if customsidebar %}

          {% include customsidebar %}

          {%- endif %}

          {%- block sidebarsearch %}

          {%- if pagename != "search" %}

            <div>

              <h3>Releases</h3>

              <ul class="last simple">

                  <li><a class="reference external" href="https://anaconda.org/jlaura/plio">Binary 0.1.0 release</a></li>

                  <li><a class="reference external" href="http://github.com/USGS-Astrogeology/plio">Development 0.1.0dev</a></li>

              </ul>

          </div>

          <div id="searchbox" style="display: none">

            <h3>{{ _('Quick search') }}</h3>

              <form class="search" action="{{ pathto('search') }}" method="get">

                <input type="text" name="q" size="18" />

                <input type="submit" value="{{ _('Go') }}" />

                <input type="hidden" name="check_keywords" value="yes" />

                <input type="hidden" name="area" value="default" />

              </form>

              <p class="searchtip" style="font-size: 90%">

              {{ _('Enter search terms or a module, class or function name.') }}

              </p>

          </div>



          <script type="text/javascript">$('#searchbox').show(0);</script>

          {%- endif %}

          {%- endblock %}

        </div>

      </div>

      {%- endif %}{% endif %}

{%- endmacro %}



<html xmlns="http://www.w3.org/1999/xhtml">

  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    {{ metatags }}

    {%- if not embedded %}

      {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}

    {%- else %}

      {%- set titlesuffix = "" %}

    {%- endif %}

    <title>{{ title|striptags }}{{ titlesuffix }}</title>

    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />

    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />

    {%- if not embedded %}

    <script type="text/javascript">

      var DOCUMENTATION_OPTIONS = {

        URL_ROOT:    '{{ pathto("", 1) }}',

        VERSION:     '{{ release|e }}',

        COLLAPSE_MODINDEX: false,

        FILE_SUFFIX: '{{ file_suffix }}',

        HAS_SOURCE:  {{ has_source|lower }}

      };

    </script>

    {%- for scriptfile in script_files %}

    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>

    {%- endfor %}

    {%- if use_opensearch %}

    <link rel="search" type="application/opensearchdescription+xml"

          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"

          href="{{ pathto('_static/opensearch.xml', 1) }}"/>

    {%- endif %}

    {%- if favicon %}

    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>

    {%- endif %}

    {%- endif %}

{%- block linktags %}

    {%- if hasdoc('about') %}

    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />

    {%- endif %}

    {%- if hasdoc('genindex') %}

    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />

    {%- endif %}

    {%- if hasdoc('search') %}

    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />

    {%- endif %}

    {%- if hasdoc('copyright') %}

    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />

    {%- endif %}

    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />

    {%- if parents %}

    <link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" />

    {%- endif %}

    {%- if next %}

    <link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />

    {%- endif %}

    {%- if prev %}

    <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />

    {%- endif %}

{%- endblock %}

{%- block extrahead %} {% endblock %}

  </head>

  <body>

{%- block header %}{% endblock %}



{%- block relbar1 %}{{ relbar() }}{% endblock %}



{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}



    <div class="document">

{%- block document %}

      <div class="documentwrapper">

      {%- if not embedded %}{% if not theme_nosidebar|tobool %}

        <div class="bodywrapper">

      {%- endif %}{% endif %}

          <div class="body">

            {% block body %} {% endblock %}

          </div>

      {%- if not embedded %}{% if not theme_nosidebar|tobool %}

        </div>

      {%- endif %}{% endif %}

      </div>

{%- endblock %}



{%- block sidebar2 %}{{ sidebar() }}{% endblock %}

      <div class="clearer"></div>

    </div>



{%- block relbar2 %}{{ relbar() }}{% endblock %}



{%- block footer %}

    <div class="footer">

    {%- if hasdoc('copyright') %}

      {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}

    {%- else %}

      {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}

    {%- endif %}

    {%- if last_updated %}

      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}

    {%- endif %}

    {%- if show_sphinx %}

      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}

    {%- endif %}

    </div>

{%- endblock %}



<!--Begin Google Analytics Code -->

<script type="text/javascript">



  var _gaq = _gaq || [];

  _gaq.push(['_setAccount', '']);

  _gaq.push(['_trackPageview']);



  (function() {

    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

  })();



</script>



<!--End Google Analytics Code -->

 </body>

</html>

docs/_templates/layout.html

+9 −2
Original line number Diff line number Diff line 
{% extends "ganalytics_layout.html" %}

{% extends '!layout.html' %}



{% block header %}

    {% include "usgsheader.html" %}

    {{ super() }}

{% endblock %}



{% block rootrellink %}

        <li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>

        <li><a href="{{ pathto('search') }}">search</a>|&nbsp;</li>

       <li><a href="{{ pathto('contents') }}">documentation </a> &raquo;</li>

       <li><a href="#documentation">documentation </a> &raquo;</li>

{% endblock %}
@@ -17,3 +21,6 @@ 
{% block sidebar1 %}{% endblock %}

{% block sidebar2 %}{{ sidebar() }}{% endblock %}



{% block footer %}

    {% include "usgsfooter.html" %}

{% endblock %}