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-10
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
::
@@ -115,14 +114,12 @@ Example:
115
114
cd docs
116
115
conda update -n base -c defaults conda
117
116
conda env update -f docs_environment.yml # with the name field set to ENVIRONMENT_NAME
118
-
python mkdemos.py
119
-
sphinx-build -b dirhtml source build
120
-
python -m http.server -d build
117
+
make dirhtml serve
121
118
122
119
Notebooks gallery
123
120
-----------------
124
121
125
-
The ``mkdemos.py`` script:
122
+
The ``mkdemos.py`` script (called by ``make dirhtml``):
126
123
127
124
- downloads notebooks from external URLs to ``source/demos/*.ipynb``
128
125
- uses the ``demos-template.rst`` file to generate the gallery in ``source/demos.rst``
@@ -136,8 +133,8 @@ Make sure that each contributed file contains the following text enclosed in the
136
133
137
134
::
138
135
139
-
Copyright 2022 United Kingdom Research and Innovation
140
-
Copyright 2022 The University of Manchester
136
+
Copyright [yyyy] United Kingdom Research and Innovation
137
+
Copyright [yyyy] The University of Manchester
141
138
Copyright [yyyy] [name of copyright owner]
142
139
Author(s): [Author name, Author email (optional)]
143
140
Licensed under the Apache License, Version 2.0 (the "License");
0 commit comments