Skip to content

Commit ef29fa8

Browse files
authored
Merge pull request #1313 from prachi237/master
Better layout configs. issue #1300 solved
2 parents 38d7bcf + 372ffe8 commit ef29fa8

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

src/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
To build the docs here locally: make sure you have Sphinx, the Cloud Sphinx Theme, and the sphinxcontrib-fulltoc Sphinx extension installed (`conda install sphinx cloud_sptheme sphinxcontrib-fulltoc`), then run `make html` (Unix) or `./make.bat html` (Windows). This will create the output files in `_build/html`.
1+
The docs are built on GitHub Actions and run the ``.ci_scripts/update_docs`` script.
2+
3+
To build the docs locally, follow the steps mentioned below:
4+
1. Clone the repository into your local machine.
5+
2. Go into the main folder and run the following commands.
6+
3. ``conda env create -f ./.ci_scripts/environment.yml``
7+
4. ``conda activate conda-forge-docs``
8+
5. ``cd newsfeed && pip install --no-deps .``
9+
6. ``cd ../src``
10+
7. ``make html``
11+
12+
Documentation update PRs should only change the files in ``src``.
13+
14+
Once the PR is merged to ``master``, you can find the auto-generated html files in ``docs`` directory.
215

3-
Documentation update PRs should only change this source; once merged to `master`, [`.ci_scripts/update_docs`](../ci_scripts/update_docs) will then automatically build it into the `docs` directory.

0 commit comments

Comments
 (0)