Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modified metadata, headings and intros #5

Merged
merged 2 commits into from
Oct 12, 2023
Merged

Modified metadata, headings and intros #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1eb52bc
Modified metadata, headings and intros
mprinkezs Oct 11, 2023
1cb01b8
Fix
mprinkezs Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/howtos/python_api_introduction/python_api_introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ myst:
      "description": "Introduction to the Python API for extending GOM Inspect 2022 with Packages/Add-ons"
      "keywords": "Metrology, GOM Inspect, Python API, GOM API, Scripting, Packages, Add-ons, How-tos"
---
# Python API introduction
# GOM Inspect Python API introduction

## Introduction to Python scripting
Welcome to the GOM Inspect Python API introduction. This is your starting point into Add-on development for GOM Inspect. Here you find out what you can do with Add-ons, how they work and how you create them.

See [Introduction to Python Scripting](https://techguide.gom.com/en/gom-software-2022/article/introduction_to_python_scripting.html) if you are new to Python or the GOM Software Python interface.

Expand Down
4 changes: 2 additions & 2 deletions doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ myst:
      "description": "Introduction to the Python API for extending GOM Inspect 2022 with Packages/Add-ons"
      "keywords": "Metrology, GOM Inspect, Python API, GOM API, Scripting, Packages, Add-ons, How-tos"
---
# Add-On Documentation
# GOM Inspect Add-On Development Documentation

Welcome to the Add-On documentation. With Add-Ons, you will be able to customize and extend the functionality of your GOM Inspect software.
Welcome to the GOM Inspect Add-On development documentation. With Add-Ons, you will be able to customize and extend the functionality of your GOM Inspect software.
You can include several template configurations from the software, as well as completely new workflows programmed in python.

```{note}
Expand Down
8 changes: 2 additions & 6 deletions doc/python_api/python_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,9 @@ myst:
"description": "GOM Inspect 2022 Add-on Python API Specification"
"keywords": "Metrology, GOM Inspect, Python API, GOM API, Scripting, Packages, Add-ons, Specification, Documentation"
---
# Python API functions
# GOM Inspect Python API documentation

## Basics

```{note}
This document describes the emerging GOM Python API.
```
Welcome to the GOM Inspect Python API documentation. Here you can find a detailed documentation of a subset of the Add-on programming specification. Please bear in mind, that recording commands with the script editor can be used to add new functions to your script.

```{important}
The now preliminary API is currently under heavy development and will change massively in the near future.
Expand Down
3 changes: 1 addition & 2 deletions doc/python_examples/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Added metadata:
---
myst:
html_meta:
Expand All @@ -7,7 +6,7 @@ myst:
---
# Overview

Welcome to the Python API Examples. Here you can find the documentation of the examples which are provided by the
Welcome to the GOM Inspect Python API Examples. Here you can find the documentation of the examples which are provided by the
`Python API Examples` Add-On. You can reuse and adapt these code examples to your specific use case and learn the best-practices we recommend.

## How the examples are structured
Expand Down