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 info about docker and MacOS #2231

Merged
merged 43 commits into from
Aug 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
6beae9a
first approach
germa89 Aug 7, 2023
8124ce0
Revert "Hiding docker (#1728)"
germa89 Aug 7, 2023
e7b8434
Fixing links to new org
germa89 Aug 7, 2023
3e4244a
Adding docker and macos sections
germa89 Aug 7, 2023
936e191
Adding info about OS in versioning
germa89 Aug 7, 2023
65e9ba7
Revamping docker compose files
germa89 Aug 7, 2023
21223dc
removing number
germa89 Aug 7, 2023
925d419
Fixing vale
germa89 Aug 7, 2023
0d4ecee
Merge branch 'main' into doc/macos-and-docker
germa89 Aug 7, 2023
6d583a5
Apply suggestions from Kathy's code review
germa89 Aug 8, 2023
f01fcc6
Apply suggestions from Robert's code review
germa89 Aug 8, 2023
f2e9cae
Fixing headings
germa89 Aug 8, 2023
3ac056f
Merge branch 'doc/macos-and-docker' of https://github.com/pyansys/pym…
germa89 Aug 8, 2023
bcd16ec
fixing bullet list
germa89 Aug 8, 2023
c4e042c
fix a reference.
germa89 Aug 8, 2023
f6f1298
Apply suggestions from Kathy's second code review
germa89 Aug 8, 2023
4551db1
Missing kathy's comment.
germa89 Aug 8, 2023
d6c29a2
Fixing vale
germa89 Aug 8, 2023
2b2ad51
Bringing change.
germa89 Aug 9, 2023
47bf63a
Using % for the indexing
germa89 Aug 9, 2023
eedaf1b
Adding resizing color.
germa89 Aug 9, 2023
4af6018
fixing bullet list
germa89 Aug 9, 2023
a02eea1
fixing pypim inventory
germa89 Aug 9, 2023
ef6d765
Merge branch 'main' into doc/macos-and-docker
germa89 Aug 10, 2023
f9eda2e
Fixing link
germa89 Aug 10, 2023
2ed9685
Merge branch 'main' into doc/macos-and-docker
germa89 Aug 10, 2023
870a82f
Update doc/source/getting_started/versioning.rst
germa89 Aug 10, 2023
e455626
Going back to normal link.
germa89 Aug 10, 2023
0727fbe
I had to remove the replaced part because it was giving an error in s…
germa89 Aug 10, 2023
239019f
Merge branch 'main' into doc/macos-and-docker
germa89 Aug 10, 2023
5fb7017
Using a new name
germa89 Aug 10, 2023
45c3242
Getting rid of the susbstitutions
germa89 Aug 10, 2023
fc09587
Following advice from Kathy.
germa89 Aug 10, 2023
e550fb5
Merge branch 'main' into doc/macos-and-docker
germa89 Aug 11, 2023
bf5a799
Atempting to fix graphviz
germa89 Aug 11, 2023
5b8ffd6
Improving diagram.
germa89 Aug 11, 2023
4401688
Last try graphviz
germa89 Aug 11, 2023
f169f89
Increasing timeout
germa89 Aug 11, 2023
38f6cfb
Removing graphviz
germa89 Aug 11, 2023
ac30a84
Update doc/source/getting_started/versioning.rst
germa89 Aug 12, 2023
57ee3e3
Merge branch 'main' into doc/macos-and-docker
germa89 Aug 12, 2023
8a79f67
Using xelatex instead.
germa89 Aug 12, 2023
391515e
Adding xelatex
germa89 Aug 13, 2023
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
4 changes: 2 additions & 2 deletions .devcontainer/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you want to build your own docker image, visit the following link
Develop on a remote container
=============================

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

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

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

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

4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ jobs:
name: "Build documentation"
runs-on: ubuntu-latest
needs: doc-style
timeout-minutes: 35
timeout-minutes: 45
outputs:
PYMAPDL_VERSION: ${{ steps.version.outputs.PYMAPDL_VERSION }}
env:
Expand All @@ -105,7 +105,7 @@ jobs:
- name: "Install OS packages"
run: |
sudo apt update
sudo apt install zip pandoc libgl1-mesa-glx xvfb texlive-latex-extra latexmk graphviz
sudo apt install zip pandoc libgl1-mesa-glx xvfb texlive-latex-extra latexmk graphviz texlive-xetex

- name: "Test virtual framebuffer"
run: |
Expand Down
4 changes: 4 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@
suppress_warnings = ["label.*"]
# supress_warnings = ["ref.option"]

# Graphviz diagrams configuration
graphviz_output_format = "png"

# numpydoc configuration
numpydoc_use_plots = True
Expand Down Expand Up @@ -285,6 +287,8 @@
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {}

latex_engine = "xelatex"

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
Expand Down
2 changes: 1 addition & 1 deletion doc/source/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ These links refers to the following GitHub repository where you can find all of

If you find a missing or broken link, open an issue in
GitHub (`PyMAPDL Issues <pymapdl_issues_>`_)
or send an email to |pyansys_contact|.
or send an email to `PyAnsys Core team <pyansys_core_>`_.
2 changes: 1 addition & 1 deletion doc/source/getting_started/contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ use these issue templates:

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

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

Viewing PyMAPDL documentation
=============================
Expand Down
Loading