Skip to content

Commit 3a3bdc4

Browse files
committed
Update makefile and workflow to use gen_apidocs instead of apidocs and other typos
1 parent 0c53daa commit 3a3bdc4

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

.github/workflows/genApiDocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
- run: pip install -r requirements.txt
2828
# ADJUST THIS: build your documentation into docs/.
2929
# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
30-
- run: make apidocs
30+
- run: make gen_apidocs
3131

3232
- uses: actions/upload-pages-artifact@v1
3333
with:

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -234,12 +234,12 @@ help:
234234
@ echo " DEBUG=1/0 debugging on/off"
235235
@ echo " VERBOSE=1/0 verbosity on/off"
236236
@ echo " "
237-
@ echo " apidocs: generate OpenTCAM API Documentation"
237+
@ echo " gen_apidocs: generate OpenTCAM API Documentation"
238238
@ echo " "
239-
@ echo " rununittest: run single table mapping test case "
240-
@ echo " runregression: run pytest regression"
239+
@ echo " run_unittest: run single table mapping test case "
240+
@ echo " run_regression: run pytest regression"
241241
@ echo " testmarkers: view opentcam table mapping test/s markers"
242-
@ echo " coverage: run opentcam table mapping test/s coverage"
242+
@ echo " run_coverage: run opentcam table mapping test/s coverage"
243243
@ echo " "
244244
@ echo " cleanvenv: delete python virtual environment/s"
245245
@ echo " cleanlogs: delete log files"

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,15 @@ Unit tests are an important part of regression testing to ensure that the code s
125125
Use the following commands:
126126
- Run a specific test:
127127
```bash
128-
make rununittest MARKER=test_name
128+
make run_unittest MARKER=test_name
129129
```
130130
- Run all tests of a specific test class:
131131
```bash
132-
make rununittest MARKER=test_class_name
132+
make run_unittest MARKER=test_class_name
133133
```
134134
- Run all regression tests:
135135
```bash
136-
make runregression
136+
make run_regression
137137
```
138138
- Display all test markers:
139139
```bash
@@ -145,15 +145,15 @@ Use the following commands:
145145
Used to gauge the effectiveness of tests. It can show which parts of your code are being exercised by tests, and which are not.
146146
- To generate code coverage simply run the command:
147147
```bash
148-
make coverage
148+
make run_coverage
149149
```
150150
A report will be created in the folder `coverage_html`. Simply open the file `coverage_html/index.html` in the web browser of your choice to view a detailed coverage report.
151151

152152
### 7. Documentation
153153
<!-- We have created a detailed presentation that serves as our documentation (for now). Take a look at it [here](). -->
154154
- To generate API documentation locally.
155155
```bash
156-
make apidocs
156+
make gen_apidocs
157157
```
158158

159159
### 8. CleanUp

0 commit comments

Comments
 (0)