Skip to content

Commit

Permalink
Docs seo (#312)
Browse files Browse the repository at this point in the history
* [doc] added meta
* [doc] added project cross-link, google site verification

Sphinx
=====
* import from parent only if not on RTD

Testing
======
* set backend to Agg for pytest action on Windows.
  • Loading branch information
marscher authored Mar 30, 2021
1 parent 9ec32a5 commit 23a879c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ jobs:
- name: pip installs
run: pip install -e .[test]

- name: setup matplotlib
if: startsWith(runner.os, 'Windows')
run: |
if not exist %userprofile%\.matplotlib\ ( mkdir %userprofile%\.matplotlib\ )
echo "backend: Agg" > %userprofile%\.matplotlib\matplotlibrc
shell: cmd

- name: run pytest
run: |
pytest -n 2 --runslow tests/
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import weldx
except Exception as ex:
raise

import weldx.visualization # load visualization
from weldx.asdf.constants import WELDX_TAG_BASE

Expand Down
10 changes: 9 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
============================================================
WelDX - data and quality standards for welding research data
============================================================

.. meta::
:description lang=en: Scientific data format and Python API for welding research data. Setup your experiment and capture data in a single file.
:keywords: welding, weld, data format, archive, scientific data, experiment, visualization, GMAW, quality standard, objectivity, comparability, reproducibility, measurement chain

.. meta::
:google-site-verification: YvWuHWCE9tERkKT7KQejAwHM2cJVSfDewd5IzGZxDsU

Introduction
############
Scientific welding data covers a wide range of physical domains and timescales and are measured using various different sensors.
Expand All @@ -12,6 +20,7 @@ The proposed file format will be developed with regards to current needs of the
By using the file format objectivity, comparability and reproducibility across different experimental setups can be improved.

The project is under active development by the `Welding Technology <https://www.bam.de/Navigation/EN/About-us/Organisation/Organisation-Chart/President/Department-9/Division-93/division93.html>`_ division at Bundesanstalt für Materialforschung und -prüfung (BAM).
Visit the projects site at `BAM <https://www.bam.de/Content/EN/Projects/WelDX/weldx.html>`_.

Python API
##########
Expand Down Expand Up @@ -48,7 +57,6 @@ Funding
#######
This research is funded by the Federal Ministry of Education and Research of Germany under project number 16QK12.


.. toctree::
:hidden:
:maxdepth: 1
Expand Down

0 comments on commit 23a879c

Please sign in to comment.