# SpinalDoc-RTD

**Repository Path**: peasent/SpinalDoc-RTD

## Basic Information

- **Project Name**: SpinalDoc-RTD
- **Description**: The sources of the online SpinalHDL doc https://spinalhdl.github.io/SpinalDoc…
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-08-30
- **Last Updated**: 2021-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

=========
SpinalDoc
=========

How to build this documentation
===============================

With venv
---------
Requirements (system)

* make
* git


Create a virtual environment with pipenv (will use the Pipfile for installing the necessary packages)

.. code:: shell

   python3 -m venv .venv

then you can activate the virtual enviroment (in bash) and install the dependencies

.. code:: shell

   source .venv/bin/activate
   pip install -r requirements.txt

and then you can use ``make`` the usual way

.. code:: shell

   make html     # for html
   make latex    # for latex
   make latexpdf # for latex (will require latexpdf installed)
   make          # list all the available output format

all the outputs will be in docs folder (for html: docs/html)

without virtualenv
------------------
Requirements (system):

* make
* git

Requirements (Python 3):

* sphinx
* sphinx-rtd-theme
* sphinxcontrib-wavedrom
* sphinx-multiversion

After installing the requirements you can run

.. code:: shell

   make html     # for html
   make latex    # for latex
   make latexpdf # for latex (will require latexpdf installed)
   make          # list all the available output format

you can create build multiple version of the doc via

.. code:: shell

   sphinx-multiversion source docs/html

in the docs/html there will be a folder with the builded doc for each branch and tag

Deploying the generated doc by hands
----------------------------------------

.. code:: shell

   git clone https://github.com/SpinalHDL/SpinalDoc-RTD.git --branch gh-pages deploy_tmp
   rm -rf deploy_tmp/*
   cp -r docs/html/* deploy_tmp/
   cd deploy_tmp/
   git add --all
   git commit -am "deploy"
   git push
   cd ..
   rm -rf deploy_tmp


Continuous Integration(CI)
==========================

This repo use Travis for his CI needs.
If you want have a gh-pages preview on your fork, you need to activate your repo on Travis admin page.
After that you only need add ``GITHUB_TOKEN`` as Environment Variable with your Github personal token (you only need grant repo/public_repo access)
More details here:

* `Defining variables <https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings>`_
* `Deploy to gh-pages <https://docs.travis-ci.com/user/deployment/pages/>`_