Skip to content

Commit ed93aec

Browse files
committed
updated Python versions docs with celbridge version
1 parent 6835472 commit ed93aec

11 files changed

Lines changed: 17 additions & 34 deletions

File tree

celbridge-docs.celbridge

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
[celbridge]
2+
celbridge-version = "0.2.0"
3+
14
[project]
2-
name = "celbridge-docs"
3-
version = "0.1.0"
45
requires-python = "3.12"
56
dependencies = [
67
"sphinx",
@@ -11,32 +12,3 @@ dependencies = [
1112
"myst-parser",
1213
"myst-parser[linkify]"
1314
]
14-
15-
[celbridge]
16-
celbridge-version = "0.2.0"
17-
18-
[[shortcut]]
19-
name = "fred"
20-
icon = "Play"
21-
tooltip = "Run the freds"
22-
23-
[[shortcut]]
24-
name = "fred/server"
25-
tooltip = "Run example web server"
26-
script = '''
27-
run "06_data_cleaning/fred.py"
28-
'''
29-
30-
[[shortcut]]
31-
name = "fred/server2"
32-
tooltip = "Run example web server2"
33-
script = '''
34-
run "06_data_cleaning/fred2.py"
35-
'''
36-
37-
[[shortcut]]
38-
name = "web server"
39-
tooltip = "web server"
40-
script='''
41-
!!python3 -m http.server 8000 --directory \docs\_build\html
42-
'''

docs/02_setup/images/.DS_Store

6 KB
Binary file not shown.

docs/02_setup/images/console.png

-25.8 KB
Binary file not shown.
63.3 KB
Loading
31 KB
Loading

docs/02_setup/python_versions.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The project settings file configures the project for a specific version of Pytho
44

55
For example, this screenshot shows the project settings file for a project named **sample-project-01**:
66

7-
```{image} /02_setup/images/project_settings_explorer_panel.png
7+
```{image} /02_setup/images/project_settings_explorer_panel2.png
88
:alt: Screenshot showing .celbridge configuration file in the file explorer panel
99
:width: 50%
1010
```
@@ -14,14 +14,19 @@ For example, this screenshot shows the project settings file for a project named
1414
The `project` section of the project settings file uses key `requires-python` to declare the Python version for the project. For example, this declares Python version **3.12** for a project:
1515

1616
```
17+
[celbridge]
18+
celbridge-version = "0.2.0"
19+
1720
[project]
1821
requires-python = "3.12"
1922
```
2023

2124
If your project requires a specific version of Python, then it's this project setting you need to ensure specifies that version.
2225

2326
:::{note}
24-
Every project **must** have a `[project]` section, with a `requires-python` key that declares the required Python language version.
27+
Every project **must** have a `[project]` section, with a `requires-python` key that declares the required Python language version.
28+
29+
It must also have a `[celbridge]` section, with a `celbridge-version` key that declares the version of Celbridge the project was created with.
2530

2631
When you create a new Celbridge project an up-to-date version of Python will automatically be declared in the project settings file created with the project.
2732
:::
@@ -39,6 +44,9 @@ For example, let's add the data analysis library [Pandas] to our Celbridge proje
3944
- ensure you wrap double-quotes around the package name.
4045

4146
```
47+
[celbridge]
48+
celbridge-version = "0.2.0"
49+
4250
[project]
4351
requires-python = "3.12"
4452
dependencies = ["pandas"]
@@ -60,6 +68,9 @@ dependencies = ["pandas"]
6068
You can specify multiple packages by declaring a comma-separate list of them in the `dependencies` key. For example, here we specify both the `"pandas"` and `"numpy"` packages:
6169

6270
```
71+
[celbridge]
72+
celbridge-version = "0.2.0"
73+
6374
[project]
6475
requires-python = "3.12"
6576
dependencies = ["pandas", "numpy"]

docs/03_getting_started/console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Celbridge comes with a **Console** panel offering a CLI (Command Line Interface). The prompt in this terminal comprises 3 greater-than signs **>>>**.
66

7-
```{image} /03_getting_started/images/console.png
7+
```{image} /03_getting_started/images/console2.png
88
:alt: Screenshot showing Console panel with some Python REPL commands
99
:width: 75%
1010
```
6 KB
Binary file not shown.
31.5 KB
Binary file not shown.
-25.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)