diff --git a/doc/Makefile b/doc/Makefile index c39e30d919..b2bf4c21e1 100755 --- a/doc/Makefile +++ b/doc/Makefile @@ -23,6 +23,7 @@ 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 @@ -30,11 +31,13 @@ clean: # 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 @@ -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)." \ No newline at end of file + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index ed937859b7..8656edc17e 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -86,6 +86,7 @@ "sphinx.ext.graphviz", "sphinx_reredirects", "ansys_sphinx_theme.extension.linkcode", + "sphinx_design", ] # Intersphinx mapping @@ -243,6 +244,7 @@ "thumbnail_size": (350, 350), "remove_config_comments": True, "default_thumb_file": pyansys_logo_white, + "show_signature": False, } # --- diff --git a/doc/source/examples/devportal.rst b/doc/source/examples/devportal.rst new file mode 100644 index 0000000000..aa38ed2a96 --- /dev/null +++ b/doc/source/examples/devportal.rst @@ -0,0 +1,42 @@ +.. _ref_devportal_examples: + + +PyMAPDL Developer Portal articles +================================= + +In this section, you'll find informative and insightful blog +articles crafted by our expert developers at Ansys and published +in the `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. diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst index 9fc3514f27..264e126179 100644 --- a/doc/source/examples/index.rst +++ b/doc/source/examples/index.rst @@ -1,5 +1,16 @@ .. _ref_examples: + +.. toctree:: + :hidden: + :maxdepth: 3 + + devportal.rst + Verification Manual + Technology Showcases + extended_examples/index.rst + + ======== Examples ======== @@ -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 - Technology Showcases - 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 diff --git a/doc/source/links.rst b/doc/source/links.rst index 5949e5276f..7ff9556992 100644 --- a/doc/source/links.rst +++ b/doc/source/links.rst @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 24e308c33d..39ced53780 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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]