The mission that this repo serves:
.. Note::
Visit <https://deeplearning540.github.io>
_ to dive into the content.
Prerequisites ^^^^^^^^^^^^^ Poetry
Please refer to https://python-poetry.org/docs/#installation for the
installation of Poetry <https://python-poetry.org>
_.
You can verify your installation using below command:
.. code-block:: bash
$ poetry --version
Build steps ^^^^^^^^^^^
.. code-block:: bash
$ git clone https://github.com/deeplearning540/deeplearning540.github.io.git
$ cd deeplearning540.github.io
Poetry <https://python-poetry.org>
_.
To build the project locally run below lines of code in your terminal:.. code-block:: bash
$ poetry install
$ poetry run make html
If all dependencies are properly installed you only are required to execute the last command:
.. code-block:: bash
$ poetry run make html
$ # Alternative way
$ poetry shell # This enables the environment for the current session
$ make html
This will place the generated documentation in :code:build/html
. Open
:code:index.html
with the browser of your choice to see the changes you
made in action, for example:
.. code-block:: bash
$ firefox build/html/index.html