Skip to content

Commit ecb5ec9

Browse files
committed
doc: introduce a script that generate the doc for cli tools
1 parent 8bc1f5a commit ecb5ec9

File tree

18 files changed

+1386
-81
lines changed

18 files changed

+1386
-81
lines changed

.vscode/launch.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@
5252
// "."
5353
"discover",
5454
"files",
55-
".."
55+
// ".."
56+
5657
]
5758
},
5859
{
@@ -71,6 +72,15 @@
7172
"justMyCode": false,
7273
"cwd": "${workspaceFolder}",
7374
},
75+
{
76+
"name": "Python: Create Cmd Line Doc",
77+
"type": "debugpy",
78+
"request": "launch",
79+
"program": "scripts/create_cmdline_doc.py",
80+
"console": "integratedTerminal",
81+
"justMyCode": false,
82+
"cwd": "${workspaceFolder}",
83+
},
7484
{
7585
"name": "Python: Attach to 5678",
7686
"type": "debugpy",

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ export default defineConfig({
108108
image: {
109109
lazyLoading: true,
110110
},
111-
lineNumbers: true,
111+
//lineNumbers: true,
112112
theme: { light: "material-theme-lighter", dark: "material-theme-darker" },
113113
headers: {
114114
level: [2, 3, 4],

docs/01_about/index.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,4 @@
1-
# About RobotCode
2-
3-
[![VS Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
4-
[![Installs](https://img.shields.io/visual-studio-marketplace/i/d-biehl.robotcode?style=flat)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
5-
[![Build Status](https://img.shields.io/github/actions/workflow/status/robotcodedev/robotcode/build-test-package-publish.yml?branch=main&style=flat&logo=github)](https://github.com/robotcodedev/robotcode/actions?query=workflow:build_test_package_publish)
6-
[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/master/LICENSE)
7-
[![PyPI - Version](https://img.shields.io/pypi/v/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
8-
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
9-
[![PyPI - Downloads](https://img.shields.io/pypi/dm/robotcode.svg?style=flat&label=downloads)](https://pypi.org/project/robotcode/)
10-
11-
---
1+
# What is RobotCode?
122

133
**RobotCode** is your all-in-one extension for working with the [Robot Framework](https://robotframework.org/) in [Visual Studio Code](https://code.visualstudio.com/). Whether you're writing, testing, or debugging, RobotCode provides a comprehensive toolkit that makes every aspect of your development process smoother and more efficient.
144

docs/02_get_started/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ Let's explore how you can enhance your development experience with RobotCode - R
99
- Robotframework version 4.1 and above
1010
- VSCode version 1.86 and above
1111

12+
## Tutorial Video
13+
14+
If you prefer to watch a video tutorial, check out the following video that covers installing, setting up and using RobotCode in Visual Studio Code. Also check out the following video I gave at RoboCon 2024:
15+
16+
<iframe width="560" height="315" src="https://www.youtube.com/embed/7Uad_250YuI?si=QyC08AOvHp2IMg9S" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
17+
18+
1219
## Installing RobotCode
1320

1421
To install RobotCode and set up your Robot Framework project in Visual Studio Code, follow these steps:

docs/03_cli/index.md

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

docs/03_cli/reference.md

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

0 commit comments

Comments
 (0)