Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
c93672b
Add logging guidelines.
MaxJPRey Dec 30, 2021
895acf3
Merge branch 'main' into feat/logging_guideline
MaxJPRey Dec 30, 2021
6161166
Add logging to the Guidelines section.
MaxJPRey Dec 30, 2021
197f8d8
Remove new line.
MaxJPRey Dec 30, 2021
5a266c1
Add images for the logging guideline.
MaxJPRey Dec 30, 2021
7ff5272
Add list of guidelines.
MaxJPRey Dec 30, 2021
5131756
Add the intersphinx extension.
MaxJPRey Dec 30, 2021
8058be4
Fix Duplicate explicit target name.
MaxJPRey Dec 30, 2021
4abfee2
add logging example module
akaszynski Dec 31, 2021
55a6d45
ignore gitignore
akaszynski Dec 31, 2021
c30fa83
Fix typo.
MaxJPRey Dec 31, 2021
79cbbc4
Why and when to log.
MaxJPRey Dec 31, 2021
3576281
Always log to share data.
MaxJPRey Dec 31, 2021
e988cbd
Add sphinx_toolbox in the doc requirements.
MaxJPRey Dec 31, 2021
c7a62c3
Improve some comments in the logging example.
MaxJPRey Jan 3, 2022
ed4c580
Replace 'file' by 'stdout' for the stream.
MaxJPRey Jan 3, 2022
07152b9
Add unit tests for the logging example module.
MaxJPRey Jan 3, 2022
ae7ef10
add literalinclude
akaszynski Jan 3, 2022
fc945eb
Merge branch 'feat/logging_guideline' of github.com:pyansys/dev-guide…
akaszynski Jan 3, 2022
c699453
Improve syntax.
MaxJPRey Jan 3, 2022
d9e88ca
Merge branch 'feat/logging_guideline' of https://github.com/pyansys/d…
MaxJPRey Jan 3, 2022
9e31599
Move the test close to the module itself.
MaxJPRey Jan 3, 2022
653567f
Add a best practice section.
MaxJPRey Jan 3, 2022
d6792c5
Move the App filter under the best practices.
MaxJPRey Jan 3, 2022
17b09eb
Improve the app filter text.
MaxJPRey Jan 3, 2022
9be5d39
Remove the sys.path.append().
MaxJPRey Jan 3, 2022
10de8df
Solve title conflict.
MaxJPRey Jan 3, 2022
aea1640
Add Logger destructeur.
MaxJPRey Jan 4, 2022
dad7861
Improve logging.Handler section.
MaxJPRey Jan 4, 2022
a49eccf
Use the tmpdir fixture.
MaxJPRey Jan 4, 2022
ee2c1b3
Improve the wrapping section.
MaxJPRey Jan 4, 2022
ef7b052
Update logging/test_pyansys_logging.py
MaxJPRey Jan 4, 2022
7de2923
Update logging/pyansys_logging.py
MaxJPRey Jan 4, 2022
37ddf87
Update logging/test_pyansys_logging.py
MaxJPRey Jan 4, 2022
6a19e7c
Add the cleanup argument.
MaxJPRey Jan 4, 2022
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
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ dist/*
#########################
*.egg-info/


# Build docs and packages
build/*
doc/build/

# virtual environment
venv/
venv/

# sphinx autogen
doc/source/documentation_style/api/*
28 changes: 20 additions & 8 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
from datetime import datetime

from pyansys_sphinx_theme import __version__, pyansys_logo_black

# Project information
project = 'PyAnsys Developers Guide'
copyright = f'{datetime.now().year}, ANSYS'
author = 'ANSYS, Inc.'
copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
author = "Ansys Inc."
release = version = '0.1.dev0'

html_logo = 'https://docs.pyansys.com/_static/pyansys-logo-black-cropped.png'
html_logo = pyansys_logo_black
html_theme = 'pyansys_sphinx_theme'

html_theme_options = {
Expand All @@ -16,21 +18,31 @@

# Sphinx extensions
extensions = [
'sphinx.ext.todo',
"sphinx_copybutton",
'sphinx_toolbox.collapse',
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
]

# Intersphinx mapping
intersphinx_mapping = {
"python": ("https://docs.python.org/dev", None),
# "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
# "numpy": ("https://numpy.org/devdocs", None),
# "matplotlib": ("https://matplotlib.org/stable", None),
# "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
# "pyvista": ("https://docs.pyvista.org/", None),
}

# The suffix(es) of source filenames.
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'


master_doc = 'index'

latex_elements = {}

# Grouping the document tree into LaTeX files. List of tuples
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

Binary file added doc/source/guidelines/images/Guidelines_chart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/guidelines/images/log_flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 13 additions & 12 deletions doc/source/guidelines/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
Guidelines
Guidelines and Best Practices
#############################
The purpose of this section is to highligh some common practices that
can be applied to the entire PyAnsys project in order to remain consistent.
This section describes and outlines several best practices that can be
applied to PyAnsys libaries for the purpose of creating effective and
efficient Python libraries to interface with Ansys products and
services. These guidelines demonstrate how applications and complex
services expose functionalities such as logging, data transfer, and
Application APIs.

One of the main objectives of PyAnsys libraries is to wrap (encapsulate)
data and methods within units of execution while hiding data or parameters
in protected variables.

Those guidelines demonstrate how applications and complex services expose
functionalities such as logging, data transfer...
Table of Contents
-----------------

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

dev_practices
app_interface_abstraction
service_abstraction
data_transfer_and_representation
logging
service_abstraction

Loading