Merge pull request #104 from firedrakeproject/connorjward/add-finat-gem

Absorb FInAT and GEM into FIAT

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.12
+      - name: Install
+        run: |
+          python -m pip install .[doc]
+      - name: Build docs
+        run: |
+          make -C docs html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html
+          publish_branch: gh-pages
+          enable_jekyll: false
+          allow_empty_commit: false
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

.github/workflows/pythonapp.yml

@@ -4,15 +4,19 @@
 
 name: FIAT CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
   build:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
       - uses: actions/checkout@v4
@@ -28,12 +32,14 @@ jobs:
         run: |
           python -m pip install pydocstyle
           python -m pydocstyle .
-      - name: Install FIAT
-        run: pip install .
-      - name: Test with pytest
+      - name: Install FIAT and CI dependencies
         run: |
-          python -m pip install coveralls pytest pytest-cov pytest-xdist
-          DATA_REPO_GIT="" python -m pytest --cov=FIAT/ test/
+          python -m pip install '.[test]'
+          python -m pip install coveralls pytest-cov
+      - name: Test FIAT
+        run: DATA_REPO_GIT="" python -m pytest --cov=FIAT/ test/FIAT
+      - name: Test FInAT
+        run: DATA_REPO_GIT="" python -m pytest --cov=finat/ --cov=gem/ test/finat
       - name: Coveralls
         if: ${{ github.repository == 'FEniCS/fiat' && github.head_ref == '' && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' }}
         env:

.gitignore

@@ -8,4 +8,8 @@
 /doc/sphinx/source/api-doc
 release/
 
-/doc/sphinx/source/_build/
+/docs/build/
+/docs/source/FIAT.rst
+/docs/source/finat.rst
+/docs/source/finat.ufl.rst
+/docs/source/gem.rst

doc/sphinx/Makefile → docs/Makefile

@@ -49,7 +49,12 @@ help:
 clean:
 	rm -rf $(BUILDDIR)/*
 
-html:
+apidoc:
+	sphinx-apidoc -f -T -o source/ ../FIAT
+	sphinx-apidoc -f -T -o source/ ../finat
+	sphinx-apidoc -f -T -o source/ ../gem
+
+html: apidoc
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

docs/source/_themes/finat/README

@@ -0,0 +1,4 @@
+This is the Sphinx theme for the FInAT web page
+It was originally based on the Firedrake web page,
+which was based on the dolfin-adjoint theme,
+which was in turn based oh the FEniCS project theme.

docs/source/_themes/finat/layout.html

@@ -0,0 +1,41 @@
+{% extends "basic/layout.html" %}
+
+{% block extrahead %}
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="{{ pathto('_static/ie6.css', 1) }}" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+<link rel="stylesheet" href="{{ pathto('_static/featured.css', 1) }}">
+
+{% if theme_favicon %}
+<link rel="shortcut icon" href="{{ pathto('_static/'+theme_favicon, 1) }}" />
+{% endif %}
+{% endblock %}
+
+{# override upper relbar to show our navigation menu #}
+{% block relbar1 %}
+<div class="wrapper">
+  <a href="{{ pathto('index.html', 1) }}"><img src="{{ pathto('_static/%s.%s' % ('banner', 'png'), 1) }}" width="900px" alt="FInAT Project Banner" /></a>
+  <div id="access">
+    <div class="menu">
+      <ul>
+          <li class="page_item"><a href="https://github.com/FInAT/finat" title="GitHub">GitHub</a></li>
+<!--          <li class="page_item"><a href="{{ pathto('documentation.html', 1) }}" title="Documentation for FInAT">Documentation</a></li>
+          <li class="page_item"><a href="{{ pathto('download.html', 1) }}" title="Obtain the FInAT code">Download</a></li>
+          <li class="page_item"><a href="{{ pathto('%s.%s' % ('team', 'html'), 1) }}" title="The guilty parties">Team</a></li>
+          <li class="page_item"><a href="{{ pathto('publications.html', 1) }}" title="Publications">Publications</a></li>
+          <li class="page_item"><a href="{{ pathto('funding.html', 1) }}" title="Our financial supporters">Funding</a></li>
+          <li class="page_item"><a href="{{ pathto('contact.html', 1) }}" title="Getting in touch">Contact</a></li>
+          <li class="page_item"><a href="http://buildbot-ocean.ese.ic.ac.uk:8080/builders/FInAT-trunk" title="Buildbot">Buildbot</a></li>-->
+      </ul>
+    </div><!-- .menu -->
+  </div><!-- #access -->
+</div><!-- #wrapper -->
+{% endblock %}
+
+{# do not display lower relbar #}
+{% block relbar2 %}{% endblock %}
+
+{# do not display sidebars #}
+{% block sidebar1 %}{% endblock %}
+{% block sidebar2 %}{% endblock %}