diff --git a/README.md b/README.md deleted file mode 100644 index aab7e7e..0000000 --- a/README.md +++ /dev/null @@ -1,150 +0,0 @@ -# PyAnsys quarto cheat sheet format - - -## Installation - -To use this extension, you must have [Quarto](https://quarto.org/docs/getting-started/installation.html) installed. - -### Install the extension - -**From the github repository:** - -From main branch: - -```bash -quarto use ansys-internal/pyansys-quarto-cheatsheet@main -``` - -From a specific release: - -```bash -quarto use ansys-internal/pyansys-quarto-cheatsheet@v0.1.0 -``` - -**From the archive file:** - -Download the cheat_sheet.zip or cheat_sheet.tar.gz file from the -[releases page](https://github.com/ansys-internal/pyansys-quarto-cheatsheet/releases) and run the following command: - -```bash -quarto use cheat_sheet.zip -``` -or -```bash -quarto use cheat_sheet.tar.gz -``` - -This command installs the extension in the quarto environment and creates -a ``_extensions`` directory in the current directory containing the extension files. - -## Usage - -```bash -quarto render examples/cheat_sheet.qmd --to cheat_sheet-pdf -``` -## Format options - -- **version**: Specifies the version of the cheat sheet. -```yaml -version: 0.1 -``` -- **title**: Sets the title of the cheat sheet. -```yaml -title: PyMAPDL cheat sheet -``` -- **footer**: Defines the footer text. -```yaml -footer: PyMAPDL cheat sheet -``` -- **footerlinks**: Specifies a list of links to display in the footer. -Each link should have a ``url`` and ``text``. -```yaml -footerlinks: -- urls: https://mapdl.docs.pyansys.com/version/stable/ - text: PyMAPDL Documentation -``` -- **format**: Determines the format of the cheat sheet. For PDF generation, use `cheat_sheet-pdf`. -```yaml -format: cheat_sheet-pdf -``` -- **execute**: Controls the code output in the code cell. Refer to the -[quarto documentation](https://quarto.org/docs/reference/cells/cells-knitr.html#code-output) -for available options. - - - *eval*: If set to `false`, the code will not be executed. - ```yaml - execute: - eval: false - ``` - - *echo*: If set to `false`, the code will not be displayed in the output. - ```yaml - execute: - echo: false - ``` - - *output*: If set to `false`, the output of the code will not be displayed. - ```yaml - execute: - output: false - ``` -### Example of a cheat sheet configuration file - -```yaml -version: 0.1 -title: PyMAPDL cheat sheet -footer: PyMAPDL cheat sheet -footerlinks: -- urls: https://mapdl.docs.pyansys.com/version/stable/ - text: PyMAPDL Documentation -format: cheat_sheet-pdf -execute: - eval: false - echo: false - output: false -``` - - -> [!NOTE] -> By default, code cells are executed. To disable execution, use the `execute` option. -> -> To disable execution and display of individual or multiple code cells, -> utilize the `eval`, `echo`and similar options within the code cell. -> ``` -> #| eval: false -> -> #| echo: false -> ``` - -> [!IMPORTANT] -> The output of the code cell is displayed by default. To disable the output, use the `execute` option. -> -> To disable the output of individual or multiple code cells, -> utilize the `output` option within the code cell. -> ``` -> #| output: false -> ``` - -### ``_quarto.yml`` file -The `_quarto.yml` file is a configuration file that contains all the metadata at the project level. -Refer to the [quarto documentation project](https://quarto.org/docs/projects/quarto-projects.html#project-metadata) -for more information. - -if you want to change the output directory, add the following line to the `_quarto.yml` file. -```yaml -output_dir: _build -``` -example of [``_quarto.yml``](_quarto.yml) file is placed in the current directory. - - -## Example - -Example of a [cheat_sheet.qmd](cheat_sheet.qmd) file is placed in the current directory. -Example of complete cheat sheet for pymapdl is placed in [pymapdl cheat sheet](examples/pymapdl_cheat_sheet_example.qmd) file. -To render the pymapdl example cheat sheet, run the following command: -```bash -quarto render examples/pymapdl_cheat_sheet_example.qmd -``` -> [!TIP] -> If you want to open a `.qmd` file in Jupyter Notebook, follow these steps: -> 1. Install `jupytext` by running the command: `pip install jupytext` -> 2. Install `jupyter` by running the command: `pip install jupyter` -> 3. Open the `.qmd` file in Jupyter Notebook with the command: `jupyter notebook cheat_sheet.qmd` diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..5b45e50 --- /dev/null +++ b/README.rst @@ -0,0 +1,62 @@ +PyAnsys Quarto Cheat Sheet +========================== +|pyansys| |GH-CI| |MIT| + +.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC + :target: https://docs.pyansys.com/ + :alt: PyAnsys + +.. |GH-CI| image:: https://github.com/ansys-internal/pyansys-quarto-cheatsheet/actions/workflows/ci_cd.yml/badge.svg + :target: https://github.com/ansys-internal/pyansys-quarto-cheatsheet/actions/workflows/ci_cd.yml + :alt: GH-CI + +.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg + :target: https://opensource.org/blog/license/mit + :alt: MIT + + +Overview +======== + +PyAnsys Quarto Cheat Sheet is an extension for using `Quarto `_, an open +source scientific and technical publishing system, to render cheat sheets from plain text +markdown and code. + +Documentation and issues +------------------------ + +Documentation for the latest stable release of PyAnsys Quarto Cheat Sheet is hosted +at `PyAnsys Quarto Cheat Sheet documentation `_. + +The documentation has these sections: + +- `Getting started `_: Learn + how to install PyAnsys Quarto Cheat Sheet in user mode. +- `User guide `_: Understand how + to render a PDF file of a cheat sheet and use its YAML configuration file to format it. +- `Examples `_: Explore examples + that show how to use PyAnsys Quarto Cheat Sheet to create and render your own cheat sheets. +- `Contribute `_: Learn how to + contribute to the PyAnsys Quarto Cheat Sheet codebase or documentation. + +In the upper right corner of the documentation's title bar, there is an option +for switching from viewing the documentation for the latest stable release +to viewing the documentation for the development version or previously +released versions. + +On the `PyAnsys Quarto Cheat Sheet Issues `_ +page, you can create issues to report bugs and request new features. On the +`Discussions `_ page on the Ansys Developer portal, +you can post questions, share ideas, and get community feedback. + +If you have general questions about the PyAnsys ecosystem, email +`pyansys.core@ansys.com `_. If your +question is specific to PyAnsys Quarto Cheat Sheet, ask your +question in an issue as described in the previous paragraph. + +License +------- + +PyAnsys Quarto Cheat Sheet is licensed under the `MIT License `_. + +PyAnsys Quarto Cheat Sheet makes no commercial claim over Ansys whatsoever. diff --git a/doc/.vale.ini b/doc/.vale.ini index f24b365..3165893 100644 --- a/doc/.vale.ini +++ b/doc/.vale.ini @@ -27,5 +27,3 @@ Vale.Terms = NO # Apply the following styles BasedOnStyles = Vale, Google - -Google.Headings = NO diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..58242e3 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,127 @@ +.. _contribute: + +Contribute +########## + +Overall guidance on contributing to a PyAnsys library appears in the +`Contributing `_ topic +in the *PyAnsys developer's guide*. Ensure that you are thoroughly familiar +with this guide before attempting to contribute to PyAnsys Quarto Cheat Sheet. + +The following contribution information is specific to PyAnsys Quarto Cheat Sheet. + +Install in developer mode +------------------------- + +Installing PyAnsys Quarto Cheat Sheet in developer mode allows you to modify +and enhance the source. + +To clone and install the latest version of PyAnsys Quarto Cheat Sheet in +development mode, run these commands: + +.. code:: + + git clone https://github.com/ansys-internal/pyansys-quarto-cheatsheet.git + cd pyansys-quarto-cheatsheet + + # Install the package in development mode + quarto install extension . --no-prompt + + +Adhere to code style +-------------------- + +PyAnsys Quarto Cheat Sheet follows the PEP8 standard as outlined in +`PEP 8 `_ in +the *PyAnsys developer's guide* and implements style checking using +`pre-commit `_. + +To ensure your code meets minimum code styling standards, run these commands:: + + pip install pre-commit + pre-commit run --all-files + +You can also install this as a pre-commit hook by running this command:: + + pre-commit install + +This way, it's not possible for you to push code that fails the style checks:: + + $ pre-commit install + $ git commit -am "feat: Added my cool features" + check yaml...............................................................Passed + trim trailing whitespace.................................................Passed + fix end of files.........................................................Passed + check for merge conflicts................................................Passed + Validate GitHub Workflows................................................Passed + Add License Headers......................................................Passed + +Render a cheat sheet +-------------------- +.. note:: + + To render a cheat sheet to a PDF file locally, you must have Quarto installed. For + installation information, see `Getting Started `_ + in the Quarto documentation. + +To render a cheat sheet to a PDF file, run a command like this one:: + + quarto render examples/cheat_sheet.qmd + +The preceding command saves the PDF file for the ``cheat_sheet.qmd`` file in +the ``Examples`` directory to the ``doc/_build`` directory by default. If you +want to change the output directory, you can modify the ``_quarto.yml`` file. +For more information, see :ref:`quarto-yml`. + +Build the documentation +----------------------- +To build the documentation locally, you must run this command to install the +documentation dependencies in the ``requirements_docs.txt`` file in the ``requirements`` +directory:: + + pip install -r requirements/requirements_doc.txt + +Then, navigate to the ``doc`` directory and run this command + +.. tab-set:: + + .. tab-item:: Linux/macOS + + .. code:: + + make html + + .. tab-item:: Windows + + .. code:: + + ./make.bat html + +The documentation is built in the ``doc/_build/html`` directory. + +You can clean the documentation build by running this command: + +.. tab-set:: + + .. tab-item:: Linux/macOS + + .. code:: + + make clean + + .. tab-item:: Windows + + .. code:: + + ./make.bat clean + +Post issues +----------- + +Use the `PyAnsys Quarto Cheat Sheet Issues `_ +page to report bugs and request new features. When possible, use the issue templates provided. +If your issue does not fit into one of these templates, click the link for opening a blank issue. + +If you have general questions about the PyAnsys ecosystem, email `pyansys.core@ansys.com `_. +If your question is specific to PyAnsys Quarto Cheat Sheet, ask your question in an issue as described +in the previous paragraph. diff --git a/doc/source/examples.rst b/doc/source/examples.rst index c9e0c6c..8a0388a 100644 --- a/doc/source/examples.rst +++ b/doc/source/examples.rst @@ -1,13 +1,16 @@ +.. _cheat_sheet_example: + Examples ======== -The following example is a simple ``.qmd`` file that uses the ``pyansys-quarto-cheat-sheet`` -package to create a cheat sheet for the PyAnsys module. +The `cheat_sheet.qmd `_ +file in the ``Examples`` directory is a simple QMD file that you can use as a template for creating +your own cheat sheets. .. literalinclude:: ../../examples/cheat_sheet.qmd :language: md -To render the cheat sheet, run the following command: +To use PyAnsys Quarto Cheat Sheet to render this QMD file as a cheat sheet in PDF format, run this command: .. code-block:: bash @@ -17,13 +20,13 @@ To render the cheat sheet, run the following command: Output ------ -The rendered cheat sheet is saved as ``cheat_sheet.pdf`` in the same directory as the input file. +The rendered cheat sheet is saved as the ``cheat_sheet.pdf`` file in the same directory as the QMD file. -The rendered cheat sheet can be downloaded by clicking the link below: +You can view a PDF file with the content originally provided in this cheat sheet by clicking the following link. +If you have run the preceding command, you can open the PDF saved in the ``Examples`` directory. +This PDF includes any changes that you might have made to the ``cheat_sheet.qmd`` file. -.. button-link:: _static/cheat_sheet.pdf - :ref-type: ref +.. button-link:: https://quarto-cheat-sheet.docs.pyansys.com/version/dev/_static/cheat_sheet.pdf :color: info - :align: center - Rendered pdf :octicon:`download;1em` + Rendered PDF file :octicon:`eye;1em` diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index 3098f1c..64022f1 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -1,50 +1,69 @@ -Getting started and basic usage -=============================== +Getting started +=============== -.. include:: ../../README.md - :parser: myst_parser.sphinx_ - :start-after: # PyAnsys quarto cheat sheet format - :end-before: > [!NOTE] +This section explains how to install PyAnsys Quarto Cheat Sheet in user mode. If you are +interested in contributing to PyAnsys Quarto Cheat Sheet, see :ref:`contribute` for information +on installing in developer mode. +Prerequisites +------------- -.. note:: +Before you can use PyAnsys Quarto Cheat Sheet, you must have Quarto installed. For installation +information, see `Getting Started `_ in +the Quarto documentation. - By default, code cells are executed. To disable execution, use the `execute` option. - To turn off execution and display of individual or multiple code cells, utilize the `execute` option within the code cell. +Installation +------------ - .. code-block:: python - :linenos: +You can install PyAnsys Quarto Cheat Sheet from the GitHub repository or from an +archive file. - #| execute: false - #| eval: false +Install from the GitHub repository +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. important:: +From the GitHub repository, you can install the latest version of PyAnsys Quart Cheat Sheet +from the main branch or install a version from a specific release branch. - The output of the code cell is displayed by default. To turn off the output, use the `execute` option. +- To install the latest version from the main branch, run this command: - To disable the output of individual or multiple code cells, - utilize the `output` option within the code cell. + .. code-block:: bash - .. code-block:: python - :linenos: + quarto use ansys-internal/pyansys-quarto-cheatsheet@main - #| output: false -``_quarto.yml`` file --------------------- +- To install the version from a specific release branch, rather than using ``@main``, use + the release branch, such as ``@v0.1.0``: -The `_quarto.yml` file is a configuration file that contains all the metadata at the project level. -Refer to the `quarto documentation project `_ -for more information. -if you want to change the output directory, add the following line to the `_quarto.yml` file. + .. code-block:: bash -.. code-block:: yaml + quarto use ansys-internal/pyansys-quarto-cheatsheet@v0.1.0 - output_dir: _build -if you want to clean the latex output, add the following line to the `_quarto.yml` file. +Install from an archive file +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. code-block:: yaml +To install from an archive file: - latex-clean: true +#. Download the ``cheat_sheet.zip`` or ``cheat_sheet.tar.gz`` archive file from the + repository's `Releases `_ + page. + +#. Run the command that installs PyAnsys Quarto Cheat Sheet in the Quarto environment from + the ZIP or TAR.GZ file. + + The command that you run creates an ``_extensions`` directory in the current directory + with all the files for PyAnsys Quarto Cheat Sheet. + + - For a ZIP file, run this command: + + .. code-block:: bash + + quarto use cheat_sheet.zip + + + - For a TAR.GZ file, run this command: + + .. code-block:: bash + + quarto use cheat_sheet.tar.gz diff --git a/doc/source/index.rst b/doc/source/index.rst index f7ab0e9..3ed2260 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,28 +1,49 @@ -PyAnsys quarto cheat sheet -========================== +PyAnsys quarto cheat sheet documentation |version| +================================================== -This is a quick reference guide for the `pyansys-quarto-cheat-sheet` package. -It is a collection of useful commands and tips for using the `pyansys-quarto-cheat-sheet` package. +PyAnsys Quarto Cheat Sheet is an extension for using `Quarto `_, an open +source scientific and technical publishing system, to generate cheat sheets from plain text +markdown and code. -.. grid:: 1 2 2 2 - :gutter: 3 3 4 4 +.. grid:: 2 .. grid-item-card:: Getting started :fa:`person-running` + :padding: 2 2 2 2 :link: getting-started :link-type: doc - How to install and import the package and basic usage. + Learn how to install PyAnsys Quarto Cheat Sheet in user mode. + + .. grid-item-card:: User guide :fa:`book-open-reader` + :padding: 2 2 2 2 + :link: user-guide + :link-type: doc + + Understand how to render a PDF file of a cheat sheet and use its + YAML configuration file to format it. .. grid-item-card:: Examples :fa:`code` + :padding: 2 2 2 2 :link: examples :link-type: doc - Examples of how to use the package. + Explore examples that show how to use PyAnsys Quarto Cheat Sheet to + create and render your own cheat sheets. + + .. grid-item-card:: Contributing :fa:`users` + :padding: 2 2 2 2 + :link: contributing + :link-type: doc + + Learn how to contribute to the PyAnsys Quarto Cheat Sheet codebase + or documentation. .. toctree:: :hidden: getting-started + user-guide examples + contributing diff --git a/doc/source/user-guide.rst b/doc/source/user-guide.rst new file mode 100644 index 0000000..1eb6aa9 --- /dev/null +++ b/doc/source/user-guide.rst @@ -0,0 +1,133 @@ +User guide +========== + +To render a cheat sheet to a PDF file locally, you run a command like this one: + +.. code-block:: bash + + quarto render examples/cheat_sheet.qmd --to cheat_sheet-pdf + + +The preceding command saves the PDF file for the ``cheat_sheet.qmd`` file in +the ``Examples`` directory to the ``doc/_build`` directory by default. If +you want to change the output directory, you can modify the ``_quarto.yml`` +file. For more information, see :ref:`quarto-yml`. + +Format options +-------------- + +The YAML configuration file for a cheat sheet specifies format options: + +- ``version``: Version of the cheat sheet:: + + version: 0.1 + +- ``title``: Title of the cheat sheet:: + + title: PyMAPDL cheat sheet + +- ``footer``: Footer text of the cheat sheet:: + + footer: PyMAPDL cheat sheet + +- ``footerlinks``: List of links to display in the footer of the cheat sheet. + Each link must have a ``urls`` and ``text`` option:: + + footerlinks: + - urls: https://mapdl.docs.pyansys.com/version/stable/ + text: PyMAPDL documentation + +- ``format``: Format for rendering the cheat sheet. For PDF generation, use ``cheat_sheet-pdf``:: + + format: cheat_sheet-pdf + +- ``execute``: Controls code and cell output. While descriptions for key options follow, see + `Code Cells: Knitr `_ in the Quarto + documentation for descriptions of all available options. + + - ``eval``: Whether to evaluate code cells. If ``False``, the code is only echoed in the output:: + + execute: + eval: false + + - ``echo``: Whether to include cell source code in the output:: + + execute: + echo: false + + - ``output``: Whether to include the results of executing the code in the output:: + + execute: + output: false + + +Configuration file example +-------------------------- + +Here is an example of a YAML configuration file:: + + version: 0.1 + title: PyMAPDL cheat sheet + footer: PyMAPDL cheat sheet + footerlinks: + - urls: https://mapdl.docs.pyansys.com/version/stable/ + text: PyMAPDL Documentation + format: cheat_sheet-pdf + execute: + eval: false + echo: false + output: false + + +By default, code cells are executed. To disable execution, for the ``execute`` option, +set ``eval: false``. + +To disable execution and exclude the cell source code in the output, +use the ``eval``, ``echo``, and similar options within the code cell:: + + #| eval: false + #| echo: false + + +By default, the results of executing the code are included in the output. To exclude these +results, for the ``execute`` option, set ``output: false``. + +.. _quarto-yml: + +The ``_quarto.yml`` file +------------------------ + +As indicated in `Project Metadata `_ +in the Quarto documentation, all Quarto projects include a ``_quarto.yml`` configuration file. Any document +rendered within the project directory automatically inherit the metadata defined at the project level. + +The root directory of the PyAnsys Cheat Sheet repository includes an example of a + `_quarto.yml `_ file. + +To change the directory that PDF files for cheat sheets are saved to, you would modify this line:: + + latex-output-dir: _build + + +Other example files +~~~~~~~~~~~~~~~~~~~ + +A Quarto QMD file is a format used for integrating plain text markdown and code into a single +compiled document. The ``Examples`` directory contains these QMD files: + +- The `cheat_sheet.qmd `_ + file is a template that you can use to create your own cheat sheets. +- The `pymapdl_cheat_sheet_example_qmd `_ + file is an example of a PyMAPDL cheat sheet. + +To render the example of a PyMAPDL cheat sheet, run this command:: + + quarto render examples/pymapdl_cheat_sheet_example.qmd + + +.. tip:: + If you want to open a QMD file in Jupyter Notebook, follow these steps: + + #. Install the ``jupytext`` package by running this command: ``pip install jupytext`` + #. Install the ``jupyter`` package by running this command: ``pip install jupyter`` + #. Open the QMD file in Jupyter Notebook by running this command: ``jupyter notebook cheat_sheet.qmd`` diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt index fa6c6a1..dc02134 100644 --- a/doc/styles/config/vocabularies/ANSYS/accept.txt +++ b/doc/styles/config/vocabularies/ANSYS/accept.txt @@ -1,4 +1,4 @@ (?!)ansys -linenos -eval disable +Knitr +pymapdl_cheat_sheet_example_qmd diff --git a/examples/cheat_sheet.qmd b/examples/cheat_sheet.qmd index 3a1bf83..7cff05d 100644 --- a/examples/cheat_sheet.qmd +++ b/examples/cheat_sheet.qmd @@ -8,9 +8,9 @@ footerlinks: text: Your text here - urls: Your URL here text: Your text here -# uncommment the following line to not to evaluate code cells +# Uncommment the following line to not evaluate code cells # execute: -# eval: false # Set to true to execute code cells +# eval: false # Set to true to evaluate code cells jupyter: jupytext: text_representation: @@ -26,7 +26,7 @@ jupyter: # General section -Discription of the first section goes here. +Description of the first section goes here. ```{python} import os @@ -34,32 +34,32 @@ import os # Section with code output -Discription of the second section goes here. +Description of the second section goes here. ```{python} -print("Hello World!") +print("Hello, world!") ``` -# Section without code output +# Section with code evaluation but no results included -This section will be evaluated but the output will not be displayed. +This section is evaluated but execution results are not included in the output. ```{python} #| output: false -print("Hello World!") +print("Hello, world!") ``` -# Section with code evaluation without output +# Section with code evaluation but no results included -This section will be evaluated but the output will not be displayed. +This section is evaluated but execution results are not included in the output. ```{python} #| output: false print(os.getcwd()) ``` -# Section with code evaluation and output +# Section with code evaluation and results included -This section will be evaluated and the output will be displayed. +This section is evaluated and execution results are included in the output. ```{python} print(os.getcwd()) @@ -71,31 +71,32 @@ print(os.getcwd()) print(os.getcwd()) ``` -If there is no evaluation, the code cell will not be executed. -So the output will not be displayed. +If there is no evaluation, the code cell is not executed. +Thus, no execution results are included in the output. # Section without code echo -This section will not be evaluated and the code cell will not be displayed on -the rendered document. -But the output will be displayed. +This section is not evaluated, and the code cell is not shown in +the rendered document. However, the output is included in the +rendered document. ```{python} #| echo: false -print("Hello World!") +print("Hello, world!") ``` # Section without code echo and output -This code cell will not be displayed on -the rendered document. -And the output will not be displayed. +This section is not evaluated, and the code cell is not shown in +the rendered document. The output is also not included in the +rendered document. + ```{python} #| echo: false #| output: false -print("Hello World!") +print("Hello, world!") ``` -# use of variables +# Use of variables ## Styles of text @@ -110,9 +111,9 @@ print("Hello World!") 2. Numbered list 3. Numbered list -- Bullet list -- Bullet list -- Bullet list +- Bulleted list +- Bulleted list +- Bulleted list ![image](./../_extensions/cheat_sheet/_static/ansys.png) diff --git a/examples/pymapdl_cheat_sheet_example.qmd b/examples/pymapdl_cheat_sheet_example.qmd index efabc64..cceb413 100644 --- a/examples/pymapdl_cheat_sheet_example.qmd +++ b/examples/pymapdl_cheat_sheet_example.qmd @@ -1,13 +1,13 @@ --- -title: PyMAPDL Cheat sheet +title: PyMAPDL cheat sheet format: cheatsheet-pdf version: 0.1.0 footer: Getting started with PyMAPDL footerlinks: - urls: 'https://mapdl.docs.pyansys.com/version/stable/' - text: PyMAPDL Documentation + text: PyMAPDL documentation - urls: 'https://mapdl.docs.pyansys.com/version/stable/getting_started/index.html' - text: PyMAPDL Documentation getting started + text: PyMAPDL documentation - Getting started execute: # output: false eval: false @@ -220,7 +220,7 @@ mapdl.lplot(vtk=False) ## References from PyMAPDL documentation -- [Getting Started](https://mapdl.docs.pyansys.com/version/stable/getting_started/index.html) +- [Getting started](https://mapdl.docs.pyansys.com/version/stable/getting_started/index.html) - [MAPDL commands](https://mapdl.docs.pyansys.com/version/stable/mapdl_commands/index.html) - [API reference](https://mapdl.docs.pyansys.com/version/stable/api/index.html)