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
## Changes
- Bring formatting code section after the Code Formatting guideline text
---------
Co-authored-by: Paul Finlay <50180049+doctorperceptron@users.noreply.github.com>
-[Validate Your Metadata File](#validate-your-metadata-file)
22
+
-[Dependency Management](#dependency-management)
23
+
-[Building and Testing Locally](#building-and-testing-locally)
24
+
-[Building a Demo in HTML Format](#building-a-demo-in-html-format)
25
+
-[Building a Demo in JSON Format](#building-a-demo-in-json-format)
26
+
-[Support](#support)
27
+
-[License](#license)
26
28
27
29
## Getting Started
28
30
@@ -88,12 +90,13 @@ While you are encouraged to be creative with your demo, please keep the followin
88
90
- **LaTeX Macros:** Avoid using LaTeX macros within your comments. Even if they appear to work in development, they will not be displayed correctly once the demo is published.
89
91
- **Author Information:** Include the author's information in the metadata.json file. See the metadata guidelines below.
90
92
- **Code Formatting:** Before submitting, run your script through the [Black Python formatter](https://github.com/psf/black):
91
-
- **Referencing Other Demos in `demo.py`:** You can reference other demos in your `demo.py` file using ``:doc:\`demos/<demo_name>\``` syntax. This will create a link to the specified demo in the documentation. For example, to reference the `tutorial_qft` demo, use ``:doc:\`demos/tutorial_qft\``` .
92
-
93
93
```bash
94
94
pip install black
95
95
black -l 100 /demonstrations_v2/tutorial_your_demo/demo.py
96
96
```
97
+
- **Referencing Other Demos in `demo.py`:** You can reference other demos in your `demo.py` file using ``:doc:\`demos/<demo_name>\``` syntax. This will create a link to the specified demo in the documentation. For example, to reference the `tutorial_qft` demo, use ``:doc:\`demos/tutorial_qft\``` .
0 commit comments