Skip to content

docs: update docs #365

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.

Sign up for GitHub

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

Merged
mortenengen merged 3 commits into from
Jun 12, 2026
Merged

docs: update docs #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3000227
Update reference to group_label attr in geometry classes
mortenengen Jun 12, 2026
5075f66
Add tip about using python install manager
mortenengen Jun 12, 2026
781deb6
Add link to python install manager
mortenengen Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/api/geometry/geometry_creation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
.. autoproperty:: x
.. autoproperty:: y
.. autoproperty:: point
.. autoproperty:: group_label

.. automethod:: translate
.. automethod:: rotate
Expand All @@ -34,6 +35,7 @@
.. autoproperty:: area
.. autoproperty:: centroid
.. autoproperty:: density
.. autoproperty:: group_label

.. automethod:: translate
.. automethod:: rotate
Expand Down Expand Up @@ -95,6 +97,7 @@ In this section the classes and methods for creating special and common geometri

.. autoproperty:: height
.. autoproperty:: width
.. autoproperty:: group_label

```

Expand All @@ -105,6 +108,7 @@ In this section the classes and methods for creating special and common geometri

.. autoproperty:: radius
.. autoproperty:: diameter
.. autoproperty:: group_label

```

Expand Down Expand Up @@ -133,6 +137,5 @@ In this section the classes and methods for creating special and common geometri
.. automethod:: __init__

.. autoproperty:: name
.. autoproperty:: group_label

```
12 changes: 9 additions & 3 deletions docs/installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python -m pip install structuralcodes
:::
::::

::::{tab-item} Python launcher
::::{tab-item} Python install manager
:sync: py

:::{code-block} pwsh
Expand All @@ -32,11 +32,17 @@ python -m pip install --upgrade structuralcodes
:::
::::

::::{tab-item} Python launcher
::::{tab-item} Python install manager
:sync: py

:::{code-block} pwsh
py -m pip install --upgrade structuralcodes
:::
::::
:::::
:::::

:::{tip}

If you are on Windows, we recommend using [Python install manager](https://docs.python.org/3/using/windows.html#python-install-manager) for installing and managing Python runtimes. Install the Python install manager with `winget` by typing `winget install python.pythoninstallmanager`.

:::
Loading