GitHub Pages
==============

On your `GitHub <https://github.com/>`_ account. Go to the project repository where you have added the docs folder.

Settings
---------------

Click Settings

.. figure:: _static/img/git-settings.png
    :alt: alternate text
    :width: 800
    :align: center

GitHub Page
-------------

On the left hand menu select Pages and under source change ``None`` to ``master`` (or ``main`` the new github nomenclature)...

.. figure:: _static/img/git-branch.jpg
    :alt: alternate text
    :width: 800
    :align: center

Folder
-------

...and   change ``root/`` folder to ``docs/`` folder

.. figure:: _static/img/git-root.jpg
    :alt: alternate text
    :width: 800
    :align: center


Save
------

Click Save

.. figure:: _static/img/git-folder.jpg
    :alt: alternate text
    :width: 800
    :align: center

We now need to wait a few seconds and refresh our browser.

.. figure:: _static/img/git-saved.jpg
    :alt: alternate text
    :width: 800
    :align: center

Hopefully, you will see that the website has been published!

Follow the link to see your website :)