https://github.com/pgaxatte/cloud-workshops

https://github.com/pgaxatte/cloud-workshops

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pgaxatte/cloud-workshops
• Owner: pgaxatte
• License: gpl-3.0
• Created: 2020-10-30T21:29:10.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-08T21:52:43.000Z (almost 3 years ago)
• Last Synced: 2023-03-21T21:29:40.787Z (almost 2 years ago)
• Language: Shell
• Size: 1.46 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Build the docs

==============

You need ``make`` in either scenarios, so first:

.. code:: shell

    # On Debian based systems:

    sudo apt-get install make

Build locally using pip

-----------------------

First, install the python3 dependencies:

.. code:: shell

    # On Debian based systems:

    sudo apt-get install python3 python3-pip python3-setuptools python3-virtualenv python3-wheel

Create a virtualenv and install Sphinx:

.. code:: shell

    python3 -m virtualenv -p /usr/bin/python3 .venv

    source .venv/bin/activate

    pip install -r requirements.txt

Now that's done, you can build the docs:

.. code:: shell

    make html

Serve it locally:

.. code:: shell

    cd _build/html

    python3 -m http.server

Read it `here `__.

Build the docker image

----------------------

That's easy:

.. code:: shell

    make docker

    docker run -p 127.0.0.1:8080:80 workshop-docs

You can now read the docs `here `__.