Skip to content

pabnas/raya_documentation_sphinx

Repository files navigation

To install project locally run the next instructions

We supposed that you clone the repository in your computer.

  1. Place into the root folder project
  2. Create a virtual enviroment:
python3 -m venv .venv
  1. Activte the virtual enviroment:
source .venv/bin/activate
  1. Iniatialize the subdmodules:
git submodule update --init
  1. Update the submodule:
git submodule update --remote
  1. Install all Python requeriments
pip install -r requirements.txt
  • Proceed to install the theme with the instructions from README_Theme.md
  • If the theme was already created and installed just build the project into the root folder.
sphinx-build -M html ./docs/source/ ./docs/build/
  • And run the project with:
sphinx-autobuild ./docs/source/ ./docs/build/html

Alternative run build_first_time.sh script into the root folder

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •