Skip to content

Commit 3db2e14

Browse files
germa89PipKatRobPasMue
authored
Adding info about docker and MacOS (#2231)
* first approach * Revert "Hiding docker (#1728)" This reverts commit 282e7d4. * Fixing links to new org * Adding docker and macos sections * Adding info about OS in versioning * Revamping docker compose files * removing number * Fixing vale * Apply suggestions from Kathy's code review Co-authored-by: Kathy Pippert <[email protected]> * Apply suggestions from Robert's code review Co-authored-by: Roberto Pastor Muela <[email protected]> * Fixing headings * fixing bullet list * fix a reference. * Apply suggestions from Kathy's second code review Co-authored-by: Kathy Pippert <[email protected]> * Missing kathy's comment. * Fixing vale * Bringing change. * Using % for the indexing * Adding resizing color. * fixing bullet list * fixing pypim inventory * Fixing link * Update doc/source/getting_started/versioning.rst * Going back to normal link. * I had to remove the replaced part because it was giving an error in sphinx. * Using a new name * Getting rid of the susbstitutions * Following advice from Kathy. * Atempting to fix graphviz * Improving diagram. * Last try graphviz * Increasing timeout * Removing graphviz --------- Co-authored-by: Kathy Pippert <[email protected]> Co-authored-by: Roberto Pastor Muela <[email protected]>
1 parent 7918659 commit 3db2e14

File tree

20 files changed

+502
-109
lines changed

20 files changed

+502
-109
lines changed

.devcontainer/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you want to build your own docker image, visit the following link
2424
Develop on a remote container
2525
=============================
2626

27-
.. note:: If you are an Ansys employee or collaborator and want to use this development method, please email |pyansys_contact|.
27+
.. note:: If you are an Ansys employee or collaborator and want to use this development method, please email `PyAnsys Core team <pyansys_core_>`_.
2828

2929
To use a `remote container <https://code.visualstudio.com/docs/devcontainers/containers>`_, you must install:
3030

@@ -111,5 +111,5 @@ You can launch a container which all the required tools and start to work in cou
111111
This is an easy way to get started with PyMAPDL development.
112112

113113
.. warning:: This method is only applicable and allowed to Ansys employees or collaborators.
114-
If you are an Ansys employee and wants use this development method, please email |pyansys_contact|.
114+
If you are an Ansys employee and wants use this development method, please email `PyAnsys Core team <pyansys_core_>`_.
115115

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
name: "Build documentation"
8585
runs-on: ubuntu-latest
8686
needs: doc-style
87-
timeout-minutes: 35
87+
timeout-minutes: 45
8888
outputs:
8989
PYMAPDL_VERSION: ${{ steps.version.outputs.PYMAPDL_VERSION }}
9090
env:
@@ -105,7 +105,7 @@ jobs:
105105
- name: "Install OS packages"
106106
run: |
107107
sudo apt update
108-
sudo apt install zip pandoc libgl1-mesa-glx xvfb texlive-latex-extra latexmk graphviz
108+
sudo apt install zip pandoc libgl1-mesa-glx xvfb texlive-latex-extra latexmk graphviz texlive-xetex
109109
110110
- name: "Test virtual framebuffer"
111111
run: |

doc/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@
105105
suppress_warnings = ["label.*"]
106106
# supress_warnings = ["ref.option"]
107107

108+
# Graphviz diagrams configuration
109+
graphviz_output_format = "png"
108110

109111
# numpydoc configuration
110112
numpydoc_use_plots = True
@@ -285,6 +287,8 @@
285287
# -- Options for LaTeX output ------------------------------------------------
286288
latex_elements = {}
287289

290+
latex_engine = "xelatex"
291+
288292
# Grouping the document tree into LaTeX files. List of tuples
289293
# (source start file, target name, title,
290294
# author, documentclass [howto, manual, or own class]).

doc/source/examples/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ These links refers to the following GitHub repository where you can find all of
5555

5656
If you find a missing or broken link, open an issue in
5757
GitHub (`PyMAPDL Issues <pymapdl_issues_>`_)
58-
or send an email to |pyansys_contact|.
58+
or send an email to `PyAnsys Core team <pyansys_core_>`_.

doc/source/getting_started/contribution.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ use these issue templates:
3838

3939
If your issue does not fit into one of these categories, create your own issue.
4040

41-
To reach the project support team, email |pyansys_contact|.
41+
To reach the project support team, email `PyAnsys Core team <pyansys_core_>`_.
4242

4343
Viewing PyMAPDL documentation
4444
=============================

0 commit comments

Comments
 (0)