Merge branch '167build_the_docs' into 'master'

DX: re-instate the build of documentation on read-the-docs

See merge request Chill-Projet/chill-bundles!638
This commit is contained in:
Julien Fastré 2023-12-13 08:39:56 +00:00
commit d1ce99e6d3
5 changed files with 15 additions and 4 deletions

View File

@ -0,0 +1,6 @@
kind: DX
body: Fixed readthedocs compilation by updating readthedocs config file and requirements
for Sphinx
time: 2023-12-12T15:44:58.282590276+01:00
custom:
Issue: "167"

View File

@ -1,10 +1,14 @@
---
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.7"
sphinx:
configuration: docs/source/conf.py
python:
version: 3.7
install:
- requirements: docs/requirements.txt
- requirements: docs/requirements.txt

View File

@ -27,7 +27,7 @@ To compile this documentation :
Contribute
===========
Issue tracker : https://git.framasoft.org/groups/Chill-project/issues
Issue tracker : https://gitlab.com/Chill-Projet/chill-bundles/-/issues
Licence
=======

View File

@ -1,6 +1,7 @@
docutils==0.13.1
Pygments==2.2.0
sphinx==1.8.5
Jinja2<3.1
git+https://github.com/fabpot/sphinx-php.git@v2.0.2#egg_name=sphinx-php
jsx-lexer===0.0.8
sphinx_rtd_theme==0.5.0

View File

@ -49,7 +49,7 @@ Clone or download the chill-skeleton project and `cd` into the main directory.
.. code-block:: bash
git clone https://gitlab.com/Chill-Projet/chill-skeleton-basic.git
cd chill-app
cd chill-skeleton-basic
As a developer, the code will stay on your computer and will be executed in docker container. To avoid permission problem, the code should be run with the same uid/gid from your current user. This is why we get your current user id with the command ``id -u`` in each following scripts.