Skip to content

Commit 6f42c68

Browse files
authored
Adding dev portal articles section (#2450)
* Adding dev portal articles section * Using html directory
1 parent 320cb6d commit 6f42c68

File tree

6 files changed

+70
-11
lines changed

6 files changed

+70
-11
lines changed

doc/Makefile

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,21 @@ help:
2323

2424
# customized clean due to examples gallery
2525
clean:
26+
@echo "Cleaning everything."
2627
rm -rf $(BUILDDIR)/*
2728
rm -rf images/auto-generated
2829
rm -rf source/examples/gallery_examples
2930
find . -type d -name "_autosummary" -exec rm -rf {} +
3031

3132
# customized clean due to examples gallery
3233
clean-except-examples:
34+
@echo "Cleaning everything except the examples."
3335
rm -rf $(BUILDDIR)/*
3436
find . -type d -name "_autosummary" -exec rm -rf {} +
3537

3638
# clean only examples
3739
clean-examples:
40+
@echo "Cleaning only the examples."
3841
rm -rf source/examples/gallery_examples
3942

4043
# customized to build the pdf rather than using latexpdf due to various issues
@@ -51,6 +54,7 @@ linkcheck:
5154
@echo "Check finished. Report is in $(LINKCHECKDIR)."
5255

5356
html-noexamples:
54-
@$(SPHINXBUILD) -D plot_gallery=0 -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
57+
@echo "Building gallery without running examples."
58+
@$(SPHINXBUILD) -D plot_gallery=0 -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
5559
@echo
56-
@echo "Build finished. The HTML pages are in $(BUILDDIR)."
60+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

doc/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@
8686
"sphinx.ext.graphviz",
8787
"sphinx_reredirects",
8888
"ansys_sphinx_theme.extension.linkcode",
89+
"sphinx_design",
8990
]
9091

9192
# Intersphinx mapping
@@ -243,6 +244,7 @@
243244
"thumbnail_size": (350, 350),
244245
"remove_config_comments": True,
245246
"default_thumb_file": pyansys_logo_white,
247+
"show_signature": False,
246248
}
247249
# ---
248250

doc/source/examples/devportal.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. _ref_devportal_examples:
2+
3+
4+
PyMAPDL Developer Portal articles
5+
=================================
6+
7+
In this section, you'll find informative and insightful blog
8+
articles crafted by our expert developers at Ansys and published
9+
in the `Developer Portal <developer_portal_>`_.
10+
Whether you're a seasoned pro or just getting started with PYMAPDL, our blog
11+
articles cover a wide range of topics, from best practices and tips to in-depth
12+
tutorials and real-world use cases. Our aim is to provide you with a valuable
13+
resource that will help you harness the full potential of PYMAPDL for your
14+
engineering and simulation needs.
15+
16+
Because the Developer Portal is your hub for all things related to Ansys
17+
products, if you have questions or suggestions, you can go there to
18+
connect to Ansys experts and the growing Ansys developer community.
19+
20+
.. Limiting the amount of lines to 2 at 80 chars
21+
.. grid:: 2
22+
:gutter: 2
23+
24+
.. grid-item-card:: Biomedical catheter design analysis
25+
:img-top: https://developer.ansys.com/sites/default/files/inline-images/BMCatheter_1_0.png
26+
:link: https://developer.ansys.com/blog/biomedical-catheter-design-analysis
27+
:text-align: center
28+
:class-title: pyansys-card-title
29+
30+
Analyzing biomedical catheter flexibility using PyMAPDL scripting to
31+
assess its flexural rigidity in various designs.
32+
33+
34+
.. grid-item-card:: Postprocessing of simplified bolted connections with the help of PyAnsys
35+
:img-top: https://developer.ansys.com/sites/default/files/inline-images/Postprocessing_of_simplified_bolted_connections_with_the_help_of_PyAnsys_image_04.jpg
36+
:link: https://developer.ansys.com/blog/postprocessing-simplified-bolted-connections-help-pyansys
37+
:text-align: center
38+
:class-title: pyansys-card-title
39+
40+
Illustrating PyMAPDL's GUI possibilities for pre-tensioned bolted
41+
connections, adhering to industry standards, and data extraction to Excel
42+
for analysis.

doc/source/examples/index.rst

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
.. _ref_examples:
22

3+
4+
.. toctree::
5+
:hidden:
6+
:maxdepth: 3
7+
8+
devportal.rst
9+
Verification Manual <https://examples.mapdl.docs.pyansys.com/verif-manual/index.html>
10+
Technology Showcases <https://examples.mapdl.docs.pyansys.com/technology_showcase_examples/index.html>
11+
extended_examples/index.rst
12+
13+
314
========
415
Examples
516
========
@@ -17,22 +28,18 @@ Here are a series of examples using MAPDL with the ``ansys-mapdl-core`` library.
1728
:start-line: 2
1829

1930

20-
.. === PYMAPDL EXAMPLES ===
31+
.. === Developer Portal examples ==
2132
22-
.. toctree::
23-
:hidden:
24-
:maxdepth: 3
33+
.. include:: devportal.rst
34+
:start-line: 2
2535

26-
Verification Manual <https://examples.mapdl.docs.pyansys.com/verif-manual/index.html>
27-
Technology Showcases <https://examples.mapdl.docs.pyansys.com/technology_showcase_examples/index.html>
28-
extended_examples/index.rst
2936

37+
.. === PyMAPDL examples ===
3038
3139
.. include:: pymapdl_examples_repo/index.rst
3240
:start-line: 2
3341

34-
.. === EXTENDED EXAMPLES ===
35-
42+
.. === Extended examples ===
3643
3744
.. include:: extended_examples/index.rst
3845
:start-line: 2

doc/source/links.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
.. _ansys_introductory_mapdl_courses: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_tut/Hlp_UI_Tutorials.html
5555
.. _ansys_current_supported_os: https://www.ansys.com/content/dam/it-solutions/platform-support/2023-r2/ansys-2023-r2-platform-support-by-application.pdf
5656

57+
.. # Developer portal
58+
.. _developer_portal: https://developer.ansys.com
59+
5760
.. # Ansys guides
5861
.. _ansys_command_reference_guide: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_cmd/Hlp_C_CmdTOC.html
5962
.. _ansys_techdemo_guide: https://ansyshelp.ansys.com/Views/Secured/corp/%%VERSION%%/en/ans_tec/tecintro.html

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ doc = [
9898
"sphinxemoji==0.2.0",
9999
"sphinx-reredirects==0.1.2",
100100
"vtk==9.2.6",
101+
"sphinx_design==0.5.0",
101102
]
102103

103104
[tool.flit.module]

0 commit comments

Comments
 (0)