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: README.rst
+10-21Lines changed: 10 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ This example shows a Jupyter Book project with Read the Docs. You're encouraged
28
28
Example Project usage
29
29
---------------------
30
30
31
-
This project has a standard Sphinx layout which is built by Read the Docs almost the same way that you would build it locally (on your own laptop!).
31
+
This project has a standard Jupyter Book layout which is built by Read the Docs almost the same way that you would build it locally (on your own laptop!).
32
32
33
33
You can build and view this documentation project locally - we recommend that you activate `a local Python virtual environment first <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment>`_:
34
34
@@ -37,25 +37,11 @@ You can build and view this documentation project locally - we recommend that yo
You can also build the documentation locally with ``make``:
48
-
49
-
.. code-block:: console
50
-
51
-
# Enter the Sphinx project
52
-
cd docs/
53
-
54
-
# Build with make
55
-
make html
56
-
57
-
# Open with your preferred browser, pointing it to the documentation index page
58
-
firefox _build/html/index.html
43
+
# View the docs with for instance firefox
44
+
firefox docs/_build/index.html
59
45
60
46
61
47
Using the example in your own project
@@ -65,11 +51,14 @@ If you are new to Read the Docs, you may want to refer to the `Read the Docs Use
65
51
66
52
If you are copying this code in order to get started with your documentation, you need to:
67
53
68
-
#. place your ``docs/`` folder alongside your Python project. If you are starting a new project, you can adapt the `pyproject.toml` example configuration.
69
54
#. use your existing project repository or create a new repository on Github, GitLab, Bitbucket or another host supported by Read the Docs
70
55
#. copy ``.readthedocs.yaml`` and the ``docs/`` folder into your project.
56
+
#. if you don't already have a ``.gitignore``, use the one from the project file -- otherwise add these lines::
57
+
58
+
/docs/conf.py
59
+
/docs/_build
60
+
71
61
#. customize all the files, replacing example contents.
72
-
#. add your own Python project, replacing the ``pyproject.toml`` configuration and ``lumache.py`` module.
73
62
#. rebuild the documenation locally to see that it works.
74
63
#. *finally*, register your project on Read the Docs, see `Importing Your Documentation <https://docs.readthedocs.io/en/stable/intro/import-guide.html>`_.
0 commit comments