Merge pull request #13 from sandialabs/dev

pages/docs revamp

Author: mrbuche

.github/workflows/docker.yml

@@ -0,0 +1,67 @@
+name: Docker
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  release:
+    types: [ "published" ]
+jobs:
+  test:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: build
+        uses: docker/build-push-action@v3
+        with:
+          push: false
+          tags: mrbuche/statmechcrack:test
+  latest:
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: login
+        uses: docker/login-action@v2
+        with:
+          username: mrbuche
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: build-push
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: mrbuche/statmechcrack:latest
+  versioned:
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    steps:
+      - name: tag
+        id: tag
+        uses: dawidd6/action-get-tag@v1
+        with:
+          strip_v: true
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: login
+        uses: docker/login-action@v2
+        with:
+          username: mrbuche
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: login
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: build-push
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: |
+            mrbuche/statmechcrack:${{steps.tag.outputs.tag}}
+            mrbuche/statmechcrack:latest
+            ghcr.io/sandialabs/statmechcrack:${{steps.tag.outputs.tag}}
+            ghcr.io/sandialabs/statmechcrack:latest

.github/workflows/docs.sh

@@ -90,35 +90,4 @@ jobs:
           conda list
           PATH="/usr/share/miniconda/bin/:$PATH"
           python -c 'import statmechcrack'
-          python -m statmechcrack.tests
-  docker:
-    needs: [get-version, pypi]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Translate README.rst to .md for description
-        run: |
-          sudo apt install -y pandoc
-          pandoc -s -o README.md README.rst
-      - name: Login to DockerHub
-        uses: docker/[email protected]
-        with:
-          username: mrbuche
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Build Docker and push to Dockerhub
-        uses: docker/[email protected]
-        with:
-          push: true
-          tags: |
-            mrbuche/statmechcrack:latest
-            mrbuche/statmechcrack:${{ needs.get-version.outputs.VERSION }}
-      - name: Give upload time before downloading
-        run: sleep 500s
-  test-docker:
-    needs: docker
-    runs-on: ubuntu-latest
-    container: mrbuche/statmechcrack
-    steps:
-      - name: Test the package
-        run: |
           python -m statmechcrack.tests

.github/workflows/package.yml

@@ -7,31 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Install package and docs extras
+      - name: install
         run: pip install .[all]
-      - name: pylint badge
+      - name: docs
         run: |
-          python -m pylint --disable=C0103 --output-format=text statmechcrack | tee pylint.log || pylint-exit $?
-          PYLINT_SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' pylint.log)
-          if (( $(echo "${PYLINT_SCORE} >= 8.0" | bc -l) )); then
-            COLOR=brightgreen
-          elif (( $(echo "${PYLINT_SCORE} >= 4.0" | bc -l) )); then
-            COLOR=yellow
-          elif (( $(echo "${PYLINT_SCORE} >= 2.0" | bc -l) )); then
-            COLOR=orange
-          else
-            COLOR=red
-          fi
-          curl "https://img.shields.io/badge/Pylint-${PYLINT_SCORE}-${COLOR}?logo=python&logoColor=FBE072" -o pylint.svg
-      - name: Build docs
-        run: |
-          sudo apt-get install pandoc
-          source .github/workflows/docs.sh
-          sphinx-build -b html source/ build/html/
-          sed -i -e "s/ module</</g" build/html/*.html
-          sed -i '/Built with/,/Docs<\/a>./d' build/html/*.html
+          cd docs/ && make html
           mv build/html/ ../public/
-          mv ../pylint.svg ../public/
       - name: Deploy docs to gh-pages
         uses: peaceiris/actions-gh-pages@v3
         with:

.github/workflows/pages.yml

@@ -1,13 +1,11 @@
 version: 2
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.9"
-sphinx:
-   configuration: docs/source/conf.py
-python:
-   install:
-   - method: pip
-     path: .
-     extra_requirements:
-       - docs
+    python: "3.11"
+  commands:
+    - pip install .[docs]
+    - pip install -r docs/requirements.txt
+    - cd docs/ && make html
+    - mkdir _readthedocs/
+    - mv docs/build/html/ _readthedocs/

.github/workflows/rtd.yml

@@ -2,15 +2,15 @@
 statMechCrack
 #############
 
-|build| |docs| |codecov| |codefactor| |pylint|
+|build| |docs| |codefactor|
 
 Statistical mechanical models for crack growth. 
 
 ************
 Installation
 ************
 
-|pypi| |conda| |docker|
+|pypi| |conda|
 
 The package can be installed using ``pip`` via the `Python Package Index <https://pypi.org/project/statmechcrack>`_ (PyPI),
 
@@ -30,24 +30,7 @@ Alternatively, a branch can be directly installed using
 
     pip install git+https://github.com/sandialabs/statmechcrack.git@<branch-name>
 
-or after cloning a branch and executing ``python setup.py install``.
-There are also `Docker images <https://hub.docker.com/r/mrbuche/statmechcrack>`_ available for use.
-In all of these cases, a valid installation can be tested by running
-
-::
-
-    python -m statmechcrack.tests
-
-***********
-Information
-***********
-
-- `Contributing <https://github.com/sandialabs/statMechCrack/blob/main/CONTRIBUTING.md>`__
-- `Documentation <https://sandialabs.github.io/statMechCrack>`__
-- `License <https://github.com/sandialabs/statmechcrack/blob/main/LICENSE>`__
-- `Releases <https://github.com/sandialabs/statmechcrack/releases>`__
-- `Repository <https://github.com/sandialabs/statmechcrack>`__
-- `Tutorial <https://sandialabs.github.io/statMechCrack/tutorial.html>`__
+or after cloning a branch and executing ``python setup.py install``. Any installation is tested by executing ``python -m statmechcrack.tests``.
 
 ********
 Citation
@@ -74,25 +57,16 @@ Copyright 2022 National Technology & Engineering Solutions of Sandia, LLC (NTESS
 .. |docs| image:: https://img.shields.io/readthedocs/statmechcrack?logo=readthedocs&label=Read%20the%20Docs
     :target: https://statmechcrack.readthedocs.io/en/latest/
 
-.. |codecov| image:: https://img.shields.io/codecov/c/github/sandialabs/statmechcrack?label=Codecov&logo=codecov
-    :target: https://codecov.io/gh/sandialabs/statmechcrack
-
 .. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sandialabs/statmechcrack?label=Codefactor&logo=codefactor
    :target: https://www.codefactor.io/repository/github/sandialabs/statmechcrack
 
-.. |pylint| image:: https://raw.githubusercontent.com/sandialabs/statmechcrack/gh-pages/pylint.svg
-    :target: https://github.com/sandialabs/statmechcrack
-
 .. |pypi| image:: https://img.shields.io/pypi/v/statmechcrack?logo=pypi&logoColor=FBE072&label=PyPI&color=4B8BBE
     :target: https://pypi.org/project/statmechcrack/
 
 .. |conda| image:: https://img.shields.io/conda/v/mrbuche/statmechcrack.svg?logo=anaconda&color=3EB049&label=Anaconda
     :target: https://anaconda.org/mrbuche/statmechcrack/
 
-.. |docker| image:: https://img.shields.io/docker/v/mrbuche/statmechcrack?color=0db7ed&label=Docker%20Hub&logo=docker&logoColor=0db7ed
-    :target: https://hub.docker.com/r/mrbuche/statmechcrack
-
-.. |license| image:: https://img.shields.io/github/license/sandialabs/statmechcrack?label=License
+.. |license| image:: https://img.shields.io/github/license/sandialabs/statmechcrack?label=License&color=yellowgreen
     :target: https://github.com/sandialabs/statmechcrack/blob/main/LICENSE
 
 .. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7008312.svg

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.rst

@@ -0,0 +1,14 @@
+{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
+{% block breadcrumbs_aside %}
+<li class="wy-breadcrumbs-aside">
+    <a style="text-decoration: none; padding: 0" href="https://github.com/sandialabs/statMechCrack">
+      <iconify-icon icon="fa-brands:github" height="1.6em"></iconify-icon>
+    </a>
+    <a style="text-decoration: none; padding: 0" href="https://pypi.org/project/statmechcrack">
+      <iconify-icon icon="simple-icons:pypi" height="1.6em"></iconify-icon>
+    </a>
+    <a style="text-decoration: none; padding: 0" href="https://anaconda.org/mrbuche/statmechcrack">
+      <iconify-icon icon="simple-icons:anaconda" height="1.6em"></iconify-icon>
+    </a>
+</li>
+{% endblock %}