Skip to content

Modify Readme with recent update. #24

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

Merged
merged 3 commits into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 16 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,15 @@ Clone and install

git clone https://<PAT>@github.com/pyansys/pyoptics.git
cd pyoptics
pip install -r requirements/requirements_style.txt
pre-commit install
python -m pip install --upgrade pip
pip install -U pip tox
tox -e style
pip install -e .


Functionalities
^^^^^^^^^^^^^^^
All sources are located in `<./ansys>`_ folder.
All sources are located in `<src/>`_ folder.

.. code:: python

Expand All @@ -66,22 +67,22 @@ All sources are located in `<./ansys>`_ folder.

Documentation
-------------
Documentation is stored in `<./doc>`_ folder and generated using `Sphinx <https://www.sphinx-doc.org/en/master/>`_.
To build it manually, just run:
Documentation is stored in `<doc>`_ folder and generated using `Sphinx`_.
To build it manually :

.. code::

pip install -r requirements/requirements_docs.txt
doc\make.bat singlehtml
pip install -U pip tox
tox -e doc && your_browser_name .tox/doc_out/index.html


.. note::

Include a link to the full sphinx documentation. For example `PyAnsys <https://docs.pyansys.com/>`_
Include a link to the full sphinx documentation. For example `PyAnsys`_

Testing
-------
Tests and assets are in `<./tests>`_ and `<./tests/assets>`_ folder.
Tests and assets are in `<tests>`_ and `<tests/assets>`_ folder.
Running PyOptics tests requires a running SpeosRPC server.
A configuration file allows to choose between a local server and a Docker server (by default).

Expand Down Expand Up @@ -130,5 +131,10 @@ Launch unit tests

License
-------
`PyOptics <https://github.com/pyansys/pyoptics>`_ is licensed under the MIT license.
`PyOptics`_ is licensed under the MIT license.
The full license can be found in the root directory of the repository, see `<LICENSE>`_.

.. LINKS AND REFERENCES
.. _PyOptics: https://github.com/pyansys/pyoptics
.. _PyAnsys: https://docs.pyansys.com
.. _Sphinx: https://www.sphinx-doc.org/en/master/
5 changes: 3 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ commands =
[testenv:doc]
description = Checks if project documentation properly builds
deps =
-r{toxinidir}/requirements/requirements_doc.txt
commands =
-r{toxinidir}/requirements/requirements_docs.txt
commands =
pip install .
sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -bhtml