Skip to content

Commit 3708bf4

Browse files
Merge pull request #2737 from VWS-Python/remove-makefile
Remove Makefile and replace make commands
2 parents 8e66aed + 60c30df commit 3708bf4

File tree

4 files changed

+24
-29
lines changed

4 files changed

+24
-29
lines changed

Makefile

Lines changed: 0 additions & 14 deletions
This file was deleted.

admin/create_secrets_files.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
"""Create licenses and target databases for the tests to run against.
22
3-
Usage:
4-
5-
$ export VWS_EMAIL_ADDRESS=...
6-
$ export VWS_PASSWORD=...
7-
# For ``make update-secrets`` to work, this has to be ``./ci_secrets``, or
8-
# you have to copy the secrets there later.
9-
$ export NEW_SECRETS_DIR=...
10-
$ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
11-
# You may have to run this a few times, but it is idempotent.
12-
$ python admin/create_secrets_files.py
3+
See the instructions in the contributing guide in the documentation.
134
"""
145

156
import datetime

docs/source/ci-setup.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ Add the encrypted secrets files to the repository:
3535

3636
.. code-block:: console
3737
38-
$ PASSPHRASE_FOR_VUFORIA_SECRETS="<CHOSEN_SECRET>" make update-secrets
38+
$ tar cvf secrets.tar ci_secrets/
39+
$ gpg --yes --batch --passphrase="${PASSPHRASE_FOR_VUFORIA_SECRETS}" --symmetric --cipher-algo AES256 secrets.tar
3940
$ git add secrets.tar.gpg
4041
$ git commit -m "Update secret archive"
4142
$ git push

docs/source/contributing.rst

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,25 @@ To create an inactive project, delete the license key associated with a database
9191
Targets sometimes get stuck at the "Processing" stage meaning that they cannot be deleted.
9292
When this happens, create a new target database to use for testing.
9393

94-
To create databases without using the browser, use :file:`admin/create_secrets_files.py`.
95-
See instructions in that file.
94+
To create databases without using the browser, use :file:`admin/create_secrets_files.py`:
95+
96+
.. code-block:: bash
97+
98+
$ export VWS_EMAIL_ADDRESS=...
99+
$ export VWS_PASSWORD=...
100+
$ export NEW_SECRETS_DIR=...
101+
$ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
102+
# You may have to run this a few times, but it is idempotent.
103+
$ python admin/create_secrets_files.py
104+
# After creating the secrets, update the encrypted archive:
105+
$ tar cvf secrets.tar "${NEW_SECRETS_DIR}"
106+
$ gpg \
107+
--yes \
108+
--batch \
109+
--passphrase="${PASSPHRASE_FOR_VUFORIA_SECRETS}" \
110+
--symmetric \
111+
--cipher-algo AES256 \
112+
secrets.tar
96113
97114
.. _Vuforia License Manager: https://developer.vuforia.com/vui/develop/licenses
98115
.. _Vuforia Target Manager: https://developer.vuforia.com/vui/develop/databases
@@ -120,8 +137,8 @@ Run the following commands to build and view documentation locally:
120137

121138
.. code-block:: console
122139
123-
$ make docs
124-
$ make open-docs
140+
$ uv run --extra=dev sphinx-build -M html docs/source docs/build -W
141+
$ python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("docs/build/html/index.html"))'
125142
126143
Continuous Integration
127144
----------------------

0 commit comments

Comments
 (0)