You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/developer_guide.rst
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,10 +98,9 @@ a HTTP server to view the documentation.
98
98
#. Update conda with ``conda update -n base -c defaults conda``
99
99
#. Follow the instructions `here <https://github.com/TomographicImaging/CIL/tree/master#building-cil-from-source-code>`_ to create a conda environment and build ``cil`` from source
100
100
#. Go to ``docs`` folder
101
-
#. Install packages from ``docs/docs_environment.yml`` (with 'name' changed to ENVIRONMENT_NAME) using ``conda env update -f docs_environment.yml``
102
-
#. Download the notebooks for rendering in the documentation with ``python mkdemos.py``
103
-
#. Build the documentation ``sphinx-build -b dirhtml source build``
104
-
#. Start a HTTP server to serve documentation with ``python -m http.server --directory build``
101
+
#. Install packages from ``docs/docs_environment.yml``
102
+
#. Build the documentation with ``make dirhtml``
103
+
#. Start an HTTP server with ``make serve`` to access the docs via `localhost:8000 <http://localhost:8000>`_.
105
104
106
105
Example:
107
106
::
@@ -117,14 +116,12 @@ Example:
117
116
cd ../docs/
118
117
conda update -n base -c defaults conda
119
118
conda env update -f docs_environment.yml # with the name field set to ENVIRONMENT_NAME
120
-
python mkdemos.py
121
-
sphinx-build -b dirhtml source build
122
-
python -m http.server -d build
119
+
make dirhtml serve
123
120
124
121
Notebooks gallery
125
122
-----------------
126
123
127
-
The ``mkdemos.py`` script:
124
+
The ``mkdemos.py`` script (called by ``make dirhtml``):
128
125
129
126
- downloads notebooks from external URLs to ``source/demos/*.ipynb``
130
127
- uses the ``demos-template.rst`` file to generate the gallery in ``source/demos.rst``
@@ -138,8 +135,8 @@ Make sure that each contributed file contains the following text enclosed in the
138
135
139
136
::
140
137
141
-
Copyright 2022 United Kingdom Research and Innovation
142
-
Copyright 2022 The University of Manchester
138
+
Copyright [yyyy] United Kingdom Research and Innovation
139
+
Copyright [yyyy] The University of Manchester
143
140
Copyright [yyyy] [name of copyright owner]
144
141
Author(s): [Author name, Author email (optional)]
145
142
Licensed under the Apache License, Version 2.0 (the "License");
0 commit comments