elowy01
1/15/2020 - 9:56 AM

Readthedocs_cheat_sheet

# Where you can see the Build of your project:
https://readthedocs.org/projects/igsr-analysis/builds/

#Sphinx configuration can be found at:
/Users/ernesto/lib/igsr_analysis/docs/conf.py

# How to build the Sphinx documentation (previous step to importing in readthedocs)
1) First, install sphinx if you have not done it yet:
pip install sphinx
2) cd /Users/ernesto/lib/igsr_analysis/docs
3) create the html:
 make html
4) Then open /Users/ernesto/lib/igsr_analysis/docs/_build/html/index.html and check
that everything is fine

# Readthedocs: Modifying the Python version that readthedocs uses to build.
1) Create a config file named .readthedocs.yml and put it in the root of the repo
(here /Users/ernesto/lib/igsr_analysis/)
 And add the following content:
 
version: 2
formats: all
sphinx:
  configuration: docs/conf.py
python:
   version: 3.5
   install:
      - requirements: docs/requirements.txt
      
##### Change the sphinx theme to Read the docs theme:

1) $ sudo pip install sphinx_rtd_theme
2) cd /Users/ernesto/lib/igsr_analysis/docs
3) emacs -nw conf.py
4) Go to the line starting with 'html_theme' and add:
$ html_theme = 'sphinx_rtd_theme'
5) make html