You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ABOUT_THIS_TEMPLATE.md
+13-7Lines changed: 13 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@ Hi, I've adapted this template from the excellent [python-project-template](http
4
4
5
5
It includes:
6
6
7
-
- 📦 A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project.
8
-
Template uses setuptools because it's the de-facto standard for Python packages
9
-
-📃 Documentation structure using [mkdocs](http://www.mkdocs.org)
10
-
-🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/)
11
-
-✅ Code linting using [pylint](https://pypi.org/project/pylint/)
12
-
-🎯 Entry points to execute your program using `python -m <ukp_project_template>` with basic CLI argument parsing.
13
-
-🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/ukp-project-template/actions) with jobs to check, lint and test your project.
7
+
- 📦 A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project;
8
+
- 📃 Documentation structure using [mkdocs](http://www.mkdocs.org);
9
+
-🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/);
10
+
-✅ Code linting using [pylint](https://pypi.org/project/pylint/);
11
+
-🎯 Entry points to execute your program using `python -m <ukp_project_template>` with basic CLI argument parsing;
12
+
-🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/ukp-project-template/actions) with jobs to check, lint and test your project;
13
+
-🌐 An out-of-the-box project page created automatically for your project.
14
14
15
15
Are there any changes you'd like to request? Feel free to fork and open a pull request!
16
16
@@ -28,6 +28,7 @@ Lets take a look at the structure of this template:
28
28
│ requirements-dev.txt # List of requirements for testing and devlopment
29
29
│ requirements.txt # An empty file to hold the requirements for the project
30
30
│ setup.py # The setup.py file for installing and packaging the project
31
+
│ index.html # The template page for the automatically generated project page
31
32
│
32
33
├───.github # Github metadata for repository
33
34
│ │ dependabot.yml # Dependabot workflow for updating requirements
@@ -46,6 +47,8 @@ Lets take a look at the structure of this template:
46
47
├───docs # Auto-generated documentation
47
48
│ index.md # Landing page of docs
48
49
│
50
+
├───static # Images & CSS files to generate the project page
51
+
│
49
52
├───ukp_project_template # The main python package for the project
50
53
│ base.py # The base module for the project
51
54
│ cli.py # Defines CLI instructions
@@ -60,6 +63,9 @@ Lets take a look at the structure of this template:
60
63
61
64
## FAQs
62
65
66
+
### How do I adapt the website to my needs ?
67
+
68
+
You should change the content of `index.html` to fit your needs. Some tinkering with the CSS inside `static` may be required.
0 commit comments