Skip to content

Commit ef82c79

Browse files
committed
[Submission] Generate readme page using hugo directly
Simpler, less generation
1 parent c6eaa8c commit ef82c79

File tree

6 files changed

+19
-87
lines changed

6 files changed

+19
-87
lines changed

Makefile

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ install: ## Install the poetry environment and install the pre-commit hooks
66

77
.PHONY: check
88
check: ## Run code quality tools.
9-
@echo "🚀 Checking for obsolete submissions/Readme.md"
10-
@poetry run python3 submissions/template/generate_Readme.py check
119
@echo "🚀 Checking Poetry lock file consistency with 'pyproject.toml': Running poetry lock --check"
1210
@poetry check --lock
1311
@echo "🚀 Linting code: Running pre-commit"
@@ -19,8 +17,6 @@ check: ## Run code quality tools.
1917

2018
.PHONY: test generation
2119
test: generation ## Test the code with pytest
22-
@echo "🚀 Generating submissions/Readme.md"
23-
@poetry run python3 submissions/template/generate_Readme.py generate
2420
@echo "🚀 Testing code: Running pytest"
2521
@poetry run pytest
2622

submissions/Readme.md

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

submissions/template/generate_Readme.py

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

submissions/template/template.md

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

web/content/solver_submission/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,21 @@ The detailed description of the fields in the solver JSON file is available in
1111
the [schema](schema.html).
1212

1313
The solver is run in [this docker](https://gitlab.com/sosy-lab/benchmarking/competition-scripts/#computing-environment-on-competition-machines) environment.
14+
15+
## Submissions directory
16+
17+
The creation of new submission is done through the creation of a new json file
18+
in this directory and the submission of a Pull Request.
19+
20+
It could be done directly from the web-interface and starting with a template:
21+
[create a new submission](https://github.com/SMT-COMP/smt-comp.github.io/new/master/submissions?value={{< submissions_template >}})
22+
23+
- The filename should start with the name of your solver and end with `.json`
24+
- The continuous integration will check the format
25+
26+
### Fields
27+
28+
- `name`: The solver name should respect the guidelines in the given in the
29+
rules of the SMT-competition (derived solver, wrapper solver, ...)
30+
- `authors`: (utf8 can be used? It should be checked. tuple with latin1?)
31+
- `url`: The url should be valid at the time of submission and during all the competition. The url should be at zenodo for the final submission.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../submissions/template/template.json

0 commit comments

Comments
 (0)