Launch v1

.circleci/config.yml

@@ -40,18 +40,18 @@ jobs:
           command: |
             poetry run black --check -t py36 launch
       - run:
-          name: Flake8 Lint Check # Uses setup.cfg for configuration
+          name: Ruff Lint Check # Uses pyproject.toml for configuration
           command: |
-            poetry run flake8 launch --count --statistics --exclude launch/clientlib
+            poetry run ruff launch
       - run:
           name: Pylint Lint Check # Uses .pylintrc for configuration
           command: |
-            poetry run pylint launch --ignore=clientlib
-      - run :
+            poetry run pylint launch --ignore=api_client,openapi_client
+      - run:
           name: MyPy typing check
           command: |
-            poetry run mypy --ignore-missing-imports launch --exclude launch/clientlib
-      - run :
+            poetry run mypy --ignore-missing-imports launch --exclude launch/api_client --exclude launch/openapi_client
+      - run:
           name: Isort Import Formatting Check # Only validation, without re-formatting
           command: |
             poetry run isort --check-only launch

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-fail_fast: true
+fail_fast: false
 repos:
 -   repo: local
     hooks:
@@ -11,8 +11,8 @@ repos:
 -   repo: local
     hooks:
     - id: system
-      name: flake8
-      entry: poetry run flake8 launch tests
+      name: ruff
+      entry: poetry run ruff launch
       pass_filenames: false
       language: system
 

.pylintrc

@@ -27,4 +27,5 @@ max-line-length=79
 
 [MASTER]
 # Ignore anything inside launch/clientlib (since it's documentation)
-ignore=clientlib
+ignore=clientlib,api_client
+extension-pkg-whitelist=pydantic

README.md

@@ -61,14 +61,16 @@ poetry run pytest
 ### Documentation
 
 **Updating documentation:**
-We use [Sphinx](https://www.sphinx-doc.org/en/master/) to autogenerate our API Reference from docstrings.
+We use [mkdocs](https://www.mkdocs.org/) to autogenerate our API Reference from docstrings and 
+markdown files.
 
 To test your local docstring changes, run the following commands from the repository's root directory:
 
 ```
 poetry shell
-cd src_docs
-sphinx-autobuild . ../docs --watch ../launch
+mkdocs serve
 ```
 
-`sphinx-autobuild` will spin up a server on localhost (port 8000 by default) that will watch for and automatically rebuild a version of the API reference based on your local docstring changes.
+The above command will spin up a server on localhost (port 8000 by default) that will watch for and
+automatically rebuild a version of the API reference based on your local docstring and markdown
+changes.