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

Adding dev portal articles section #2450

Merged
merged 4 commits into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,21 @@ help:

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

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

# clean only examples
clean-examples:
@echo "Cleaning only the examples."
rm -rf source/examples/gallery_examples

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

html-noexamples:
@$(SPHINXBUILD) -D plot_gallery=0 -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@echo "Building gallery without running examples."
@$(SPHINXBUILD) -D plot_gallery=0 -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)."
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
2 changes: 2 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
"sphinx.ext.graphviz",
"sphinx_reredirects",
"ansys_sphinx_theme.extension.linkcode",
"sphinx_design",
]

# Intersphinx mapping
Expand Down Expand Up @@ -243,6 +244,7 @@
"thumbnail_size": (350, 350),
"remove_config_comments": True,
"default_thumb_file": pyansys_logo_white,
"show_signature": False,
}
# ---

Expand Down
42 changes: 42 additions & 0 deletions doc/source/examples/devportal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.. _ref_devportal_examples:


PyMAPDL Developer Portal articles
=================================

In this section, you'll find informative and insightful blog
germa89 marked this conversation as resolved.
Show resolved Hide resolved
articles crafted by our expert developers at Ansys and published
in the `Developer Portal <developer_portal_>`_.
Whether you're a seasoned pro or just getting started with PYMAPDL, our blog
articles cover a wide range of topics, from best practices and tips to in-depth
tutorials and real-world use cases. Our aim is to provide you with a valuable
resource that will help you harness the full potential of PYMAPDL for your
engineering and simulation needs.

Because the Developer Portal is your hub for all things related to Ansys
products, if you have questions or suggestions, you can go there to
connect to Ansys experts and the growing Ansys developer community.

.. Limiting the amount of lines to 2 at 80 chars
.. grid:: 2
:gutter: 2

.. grid-item-card:: Biomedical catheter design analysis
:img-top: https://developer.ansys.com/sites/default/files/inline-images/BMCatheter_1_0.png
:link: https://developer.ansys.com/blog/biomedical-catheter-design-analysis
:text-align: center
:class-title: pyansys-card-title

Analyzing biomedical catheter flexibility using PyMAPDL scripting to
assess its flexural rigidity in various designs.


.. grid-item-card:: Postprocessing of simplified bolted connections with the help of PyAnsys
:img-top: https://developer.ansys.com/sites/default/files/inline-images/Postprocessing_of_simplified_bolted_connections_with_the_help_of_PyAnsys_image_04.jpg
:link: https://developer.ansys.com/blog/postprocessing-simplified-bolted-connections-help-pyansys
:text-align: center
:class-title: pyansys-card-title

Illustrating PyMAPDL's GUI possibilities for pre-tensioned bolted
connections, adhering to industry standards, and data extraction to Excel
for analysis.
25 changes: 16 additions & 9 deletions doc/source/examples/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
.. _ref_examples:


.. toctree::
:hidden:
:maxdepth: 3

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


========
Examples
========
Expand All @@ -17,22 +28,18 @@ Here are a series of examples using MAPDL with the ``ansys-mapdl-core`` library.
:start-line: 2


.. === PYMAPDL EXAMPLES ===
.. === Developer Portal examples ==

.. toctree::
:hidden:
:maxdepth: 3
.. include:: devportal.rst
:start-line: 2

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

.. === PyMAPDL examples ===

.. include:: pymapdl_examples_repo/index.rst
:start-line: 2

.. === EXTENDED EXAMPLES ===

.. === Extended examples ===

.. include:: extended_examples/index.rst
:start-line: 2
Expand Down
3 changes: 3 additions & 0 deletions doc/source/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@
.. _ansys_introductory_mapdl_courses: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_tut/Hlp_UI_Tutorials.html
.. _ansys_current_supported_os: https://www.ansys.com/content/dam/it-solutions/platform-support/2023-r2/ansys-2023-r2-platform-support-by-application.pdf

.. # Developer portal
.. _developer_portal: https://developer.ansys.com

.. # Ansys guides
.. _ansys_command_reference_guide: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/ans_cmd/Hlp_C_CmdTOC.html
.. _ansys_techdemo_guide: https://ansyshelp.ansys.com/Views/Secured/corp/%%VERSION%%/en/ans_tec/tecintro.html
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ doc = [
"sphinxemoji==0.2.0",
"sphinx-reredirects==0.1.2",
"vtk==9.2.6",
"sphinx_design==0.5.0",
]

[tool.flit.module]
Expand Down