Skip to content

b1-luettje/documentation

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Betacloud documentation

Build Status

Published at https://docs.betacloud.io.

Install dependencies for building documentation

https://docs.openstack.org/doc-contrib-guide/docs-builds.html#install-dependencies-for-building-documentation

  • On Ubuntu or Debian:

    # apt-get install python-pip
    # pip install tox
    
  • On RHEL or CentOS (replace yum with dnf on Fedora):

    # yum install python-pip
    # pip install tox
    
  • On openSUSE or SUSE Linux Enterprise:

    # zypper in python-pip
    # pip install tox
    
  • On MacOS:

    $ brew install python
    $ pip install tox
    
  • On Windows:

    $ pip install tox
    

Building

All guides are in the RST format. You can use tox to prepare virtual environment and build all guides (HTML only):

$ tox -e build

You can find the root of the generated HTML documentation at build/html.

Pushing

$ export FTP_USERNAME=username
$ export FTP_PASSWORD=password
$ tox -e push

Generated files

Some documentation files are generated using tools. These files include a do not edit header and should not be modified by hand.

License

This documentation was created by Betacloud Solutions GmbH and is licensed under a Creative Commons Attribution 4.0 International Licence (CC BY-SA 4.0).

Creative Commons Attribution-ShareAlike 4.0 International

About

Betacloud documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%