Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc/#1007 improve navigability #1105

Merged
merged 40 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
6a09c6d
Styling and tabs
FlorianJacta Aug 29, 2024
e1e8dd8
Merge branch 'develop' into doc/#1007-improve-navigability
FlorianJacta Aug 29, 2024
8145d0f
Refactoring of doc
FlorianJacta Aug 29, 2024
63d6852
Fix Markdown inclusion
FlorianJacta Aug 30, 2024
707f60f
Fix Getting Started
FlorianJacta Aug 30, 2024
4893d97
scenario_features as new folder
FlorianJacta Aug 30, 2024
b86a761
Fix links
FlorianJacta Aug 30, 2024
912e862
Fix links
FlorianJacta Aug 30, 2024
b5cc2c1
Fix links
FlorianJacta Aug 30, 2024
e5b3175
Fix links
FlorianJacta Aug 30, 2024
c0d7de1
Boost partial and fix link
FlorianJacta Aug 30, 2024
b489350
Fix navigation and links
FlorianJacta Aug 30, 2024
3ab2ced
Rename to Scenario Features
FlorianJacta Sep 2, 2024
25de93b
Fix links
FlorianJacta Sep 3, 2024
ee1251a
Fix links
FlorianJacta Sep 3, 2024
bf7e70e
Fix links
FlorianJacta Sep 3, 2024
57573bb
Merge branch 'develop' into doc/#1007-improve-navigability
FlorianJacta Sep 3, 2024
5e0614d
Merge branch 'develop' into doc/#1007-improve-navigability
FlorianJacta Sep 3, 2024
16edcb3
Integrate Events in new doc
FlorianJacta Sep 3, 2024
6c7c64c
Fix icons and anchor
FlorianJacta Sep 3, 2024
27134e0
Delete print and correct anchor
FlorianJacta Sep 3, 2024
6880049
Update .gitignore
FlorianJacta Sep 3, 2024
8a29f48
Fix contributing
FlorianJacta Sep 3, 2024
f33a1a9
Reorder tutos
FlorianJacta Sep 4, 2024
1130eff
Change events place in navigation
FlorianJacta Sep 4, 2024
31ddeba
Fix quick access
FlorianJacta Sep 4, 2024
eeb632a
Fix doc generation for Gui Builder
FlorianJacta Sep 4, 2024
30c7e24
Fix modules issue
FlorianJacta Sep 4, 2024
757a1de
Remove dead links
FlorianJacta Sep 4, 2024
e9e9c4b
Remove generated files
jrobinAV Sep 4, 2024
5334c5b
Add generated files to gitignore
jrobinAV Sep 4, 2024
f97ce9f
Add Gui example
FlorianJacta Sep 4, 2024
dff91f3
Merge branch 'doc/#1007-improve-navigability' of https://github.com/A…
FlorianJacta Sep 4, 2024
2369492
Fix wrong links and improve quick access pills
jrobinAV Sep 4, 2024
84a6cca
Fix navbar
jrobinAV Sep 4, 2024
98a24e8
Merge branch 'doc/#1007-improve-navigability' of https://github.com/A…
FlorianJacta Sep 5, 2024
faa1c34
Improve event documentation
jrobinAV Sep 5, 2024
07f9c26
Rename section on Page navigation
jrobinAV Sep 5, 2024
5e11944
Group viz elements by lib
jrobinAV Sep 5, 2024
8885df9
Group viz elements by lib
jrobinAV Sep 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
25 changes: 13 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -111,21 +111,22 @@ site/
mkdocs.yml
/taipy
/taipy-fe
/docs/manuals/userman/gui/viselements/index.md
docs/manuals/userman/gui/viselements/generic/*.md
!docs/manuals/userman/gui/viselements/generic/index.md
docs/manuals/userman/gui/viselements/generic/charts/*.md
docs/manuals/userman/gui/viselements/corelements/*.md
!docs/manuals/userman/gui/gui_example.ipynb
docs/manuals/xrefs
docs/manuals/refmans/reference/**/*.md
!docs/manuals/refmans/reference/index.md
docs/manuals/refmans/reference_rest/*.md
!docs/manuals/refmans/reference_rest/index.md
docs/manuals/refmans/reference_guiext/
/docs/refmans/gui/viselements/index.md
docs/refmans/gui/viselements/generic/*.md
!docs/refmans/gui/viselements/generic/index.md
docs/refmans/gui/viselements/generic/charts/*.md
docs/refmans/gui/viselements/corelements/*.md
!docs/userman/gui/gui_example.ipynb
docs/userman/xrefs
docs/refmans/reference/**/*.md
!docs/refmans/reference/index.md
docs/refmans/reference_rest/*.md
!docs/refmans/reference_rest/index.md
docs/refmans/reference_guiext/
docs/contributing/contributors.md
fe_node_modules/
docs/tutorials/index.md
docs/tutorials/getting_started/index.md
docs/tutorials/scenario_management/index.md
docs/tutorials/visuals/index.md
docs/tutorials/integration/index.md
Expand Down
22 changes: 13 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Create a folder to organize your application description. Use a clear and concis
for the folder that represents the content. For example:

```
docs/gallery/{category}/your_folder/
docs/gallery/articles/your_folder/
```

Category is the category of the article (finance, decision_support, llm,
Expand All @@ -184,6 +184,7 @@ integration or large data)
- type: The type of the item (code, video or article)
- data-keywords: A comma separated list of keywords
- short-description: A short description of the item
- order: The order of the item in the gallery
- img: The path to the image associated with the item

This header will be used to display the article in the correct pages.
Expand All @@ -196,6 +197,7 @@ title: Realtime Pollution Dashboard
category: visualization
data-keywords: dashboad
short-description: Streams real-time pollution data from sensors and shows air quality on a map.
order: 26
img: pollution_sensors/images/pollution_dashboard.png
---

Expand Down Expand Up @@ -223,7 +225,7 @@ You shall then describe your application in more details.
Add the new Markdown file to the "mkdocs.yml_template" file in the appropriate section.

```
"Title of the Application": gallery/{category}/your_folder/index.md
"Title of the Application": gallery/articles/your_folder/index.md
```

#### Checklist:
Expand All @@ -233,8 +235,8 @@ Add the new Markdown file to the "mkdocs.yml_template" file in the appropriate s
if any are present.
- Break lines in the Markdown file before 100 characters.
- Use relative links to taipy doc (.md). To express
`https://docs.taipy.io/en/latest/manuals/studio/config/` in a tip article, write
`../../../manuals/studio/config/index.md`.
`https://docs.taipy.io/en/latest/userman/ecosystem/studio/config/` in a tip article, write
`../../../userman/ecosystem/studio/config/index.md`.
- Follow conventions for styling code, variables, etc.
- Check the level of titles in the Markdown file.
- Build the doc and test the page. See [INSTALLATION.md](INSTALLATION.md)
Expand All @@ -254,7 +256,7 @@ Create a folder to organize your tutorial. Use a clear and concise name for the
folder that represents the content. For example:

```
docs/tutorials/{category}/your_folder/
docs/tutorials/articles/your_folder/
```

Category is the category of the article (fundamentals, visuals, scenario
Expand All @@ -273,6 +275,7 @@ The header contains the following information:
integration or large data)
- data-keywords: A comma separated list of keywords
- short-description: A short description of the item
- order: The order of the item in the tutorials
- img: The path to the image associated with the item

This header will be used to display the article in the correct pages.
Expand All @@ -285,7 +288,8 @@ title: Scenarios
category: scenario_management
data-keywords: scenario cycle configuration datanode dag
short-description: A Taipy scenario models an instance of your end-user business problem to solve on data and parameter sets.
img: 1_scenarios/images/scenario.png
order: 26
img: scenarios/images/scenario.png
---

And here is the content of my article...
Expand All @@ -296,7 +300,7 @@ And here is the content of my article...
Add the new Markdown file to the "mkdocs.yml_template" file in the appropriate section.

```
"Title of the Article": tutorials/{category}/your_folder/index.md
"Title of the Article": tutorials/articles/your_folder/index.md
```

#### Checklist:
Expand All @@ -306,8 +310,8 @@ Add the new Markdown file to the "mkdocs.yml_template" file in the appropriate s
if any are present.
- Break lines in the Markdown file before 100 characters.
- Use relative links to taipy doc (.md). To express
`https://docs.taipy.io/en/latest/manuals/studio/config/` in a tip article, write
`../../../manuals/studio/config/index.md`.
`https://docs.taipy.io/en/latest/userman/ecosystem/studio/config/` in a tip article, write
`../../../userman/ecosystem/studio/config/index.md`.
- Follow conventions for styling code, variables, etc.
- Check the level of titles in the Markdown file.
- Build the doc and test the page. See [INSTALLATION.md](INSTALLATION.md)
56 changes: 32 additions & 24 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,19 @@ from initial prototypes to production-ready applications.

<ul class="tp-pills-list">
<li>
<a class="tp-pill" href="manuals/userman/gui/viselements/generic/chart/">
<a class="tp-pill" href="refmans/gui/viselements/generic/chart/">
<span>Chart</span>
<div class="tp-tooltip">
<img src="manuals/userman/gui/viselements/generic/chart-d.png"/>
<img src="refmans/gui/viselements/generic/chart-d.png"/>
<p>A chart visually depicts data through graphs, charts, or plots.</p>
</div>
</a>
</li>
<li>
<a class="tp-pill" href="manuals/userman/gui/viselements/generic/table/">
<a class="tp-pill" href="refmans/gui/viselements/generic/table/">
<span>Table</span>
<div class="tp-tooltip">
<img src="manuals/userman/gui/viselements/generic/table-d.png"/>
<img src="refmans/gui/viselements/generic/table-d.png"/>
<p>
A table presents data in rows and columns, often used in web applications for structured
data display and interaction.
Expand All @@ -73,34 +73,34 @@ from initial prototypes to production-ready applications.
</a>
</li>
<li>
<a class="tp-pill" href="manuals/userman/gui/viselements/generic/button/">
<a class="tp-pill" href="refmans/gui/viselements/generic/button/">
<span>Button</span>
<div class="tp-tooltip">
<img src="manuals/userman/gui/viselements/generic/button-d.png" alt="">
<img src="refmans/gui/viselements/generic/button-d.png" alt="">
<p>You can employ this class name to target the buttons on your page and apply styling.</p>
</div>
</a>
</li>
<li>
<a class="tp-pill" href="manuals/userman/gui/viselements/generic/input/">
<a class="tp-pill" href="refmans/gui/viselements/generic/input/">
<span>Input</span>
<div class="tp-tooltip">
<img src="manuals/userman/gui/viselements/generic/input-d.png"/>
<img src="refmans/gui/viselements/generic/input-d.png"/>
<p>A control that displays some text that can potentially be edited.</p>
</div>
</a>
</li>
<li>
<a class="tp-pill" href="manuals/userman/gui/viselements/generic/slider/">
<a class="tp-pill" href="refmans/gui/viselements/generic/slider/">
<span>Slider</span>
<div class="tp-tooltip">
<img src="manuals/userman/gui/viselements/generic/slider-d.png"/>
<img src="refmans/gui/viselements/generic/slider-d.png"/>
<p>Displays and allows the user to set a value within a range.</p>
</div>
</a>
</li>
<li>
<a class="tp-pill" href="manuals/userman/gui/viselements/generic/controls/">
<a class="tp-pill" href="refmans/gui/viselements/">
<span>…</span>
<div class="tp-tooltip">
<p>Browse the complete list of visual elements.</p>
Expand All @@ -113,34 +113,42 @@ from initial prototypes to production-ready applications.

<ul class="tp-pills-list">
<li>
<a class="tp-pill" href="manuals/userman/gui/viselements/generic/blocks/">
<a class="tp-pill" href="refmans/gui/viselements/#block-elements">
<span>Structure Pages</span>
</a>
</li>
<li>
<div class="tp-pill">
<a href="manuals/userman/sdm/scenario/#scenario-configuration">Configure</a>,
<a href="manuals/userman/sdm/scenario/#scenario-creation">instantiate</a> and
<a href="manuals/userman/sdm/scenario/#scenario-submission">submit</a> Scenario
</div>
</li>
<li>
<a class="tp-pill" href="manuals/userman/versioning/">
<span>Manage versions</span>
<a class="tp-pill" href="userman/scenario_features/data-integration/">
<span>Data integration</span>
</a>
</li>
<li>
<a class="tp-pill" href="userman/scenario_features/task-orchestration/">
<span>Task orchestration</span>
</a>
</li>
<li>
<a class="tp-pill" href="userman/scenario_features/what-if-analysis/">
<span>What if analysis</span>
</a>
</li>
<li>
<a class="tp-pill" href="userman/advanced_features/versioning/">
<span>Version management</span>
</a>
</li>
<li>
<a class="tp-pill" href="manuals/cli/">
<a class="tp-pill" href="userman/ecosystem/cli/">
<span>Taipy command-line interface (CLI)</span>
</a>
</li>
<li>
<a class="tp-pill" href="manuals/userman/rest/">
<a class="tp-pill" href="userman/scenario_features/rest/">
<span>Expose Taipy's REST APIs</span>
</a>
</li>
<li>
<a class="tp-pill" href="manuals/userman/">
<a class="tp-pill" href="userman/">
<span>…</span>
<div class="tp-tooltip">
<p>Browse the complete list of features.</p>
Expand Down
24 changes: 0 additions & 24 deletions docs/manuals/index.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs/manuals/userman/sdm/events/examples.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here is what the control looks like when connected to a scenario instance:
</figure>

The visual representation of the Data Nodes and Tasks is the same as the one used in the
[Taipy Studio extension](../../../../studio/config/graphview.md).
[Taipy Studio extension](../../../../userman/ecosystem/studio/config/graphview.md).

The toolbar, which can be removed by setting the [*show_toolbar*](#p-show_toolbar) property to
False, contains a button that adapts the rendering area zoom factor to the graph representation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ A control that can trigger a function when pressed.
All the button controls are generated with the "taipy-button" CSS class. You can use this class
name to select the buttons on your page and apply style.

## [Stylekit](../../styling/stylekit.md) support
## [Stylekit](../../../../userman/gui/styling/stylekit.md) support

The [Stylekit](../../styling/stylekit.md) provides specific classes that you can use to style buttons:
The [Stylekit](../../../../userman/gui/styling/stylekit.md) provides specific classes that you can use to style buttons:

* *secondary*<br/>*error*<br/>*warning*<br/>*success*<br/>
Buttons are normally displayed using the value of the *color_primary* Stylekit variable.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -284,9 +284,9 @@ button, the page will reflect the change without explicit refresh:
All the chart controls are generated with the "taipy-chart" CSS class. You can use this class
name to select the charts on your page and apply style.

## [Stylekit](../../styling/stylekit.md) support
## [Stylekit](../../../../userman/gui/styling/stylekit.md) support

The [Stylekit](../../styling/stylekit.md) provides a specific class that you can use to style charts:
The [Stylekit](../../../../userman/gui/styling/stylekit.md) provides a specific class that you can use to style charts:

* *has-background*<br/>
When the chart control uses the *has-background* class, the rendering of the chart
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ def on_change(state, var, val):
```

The part you should be looking at is the use of the default callback property
[*on_change*](../../../callbacks.md#variable-value-change): it detects the changes in
[*on_change*](../../../../../userman/gui/callbacks.md#variable-value-change): it detects the changes in
*selected_indices* and calculates the mean, which updates the text in the title.

We also create two objects (*layout* and *config*) used to remove the mode
Expand Down
Loading
Loading