Skip to content
This repository was archived by the owner on Jun 7, 2023. It is now read-only.

Commit 90bc9eb

Browse files
committed
add overview
1 parent 043b805 commit 90bc9eb

File tree

2 files changed

+629
-10
lines changed

2 files changed

+629
-10
lines changed

runestone/common/newproject_copy_me/_sources/index.rst

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,31 @@ This Is A New Project
1414
.. Sources can also be included from subfolders of this directory.
1515
(e.g. "DataStructures/queues.rst").
1616
17-
SECTION 1: A Random Section
17+
SECTION 1: Introduction
1818
:::::::::::::::::::::::::::
1919

20-
.. toctree::
21-
:maxdepth: 2
20+
Congratulations! If you can see this file you have probably successfully run the ``runestone init`` command. If you are looking at this as a source file you should now run ``runestone build`` to generate html files. Once you have run the build command you can run ``runestone serve`` and then view this in your browser at ``http://localhost:8000``
2221

23-
functions.rst
24-
DataStructures/queues.rst
22+
This is just a sample of what you can do. The index.rst file is the table of contents for your entire project. You can put all of your writing in the index, or as you will see in the following section you can include additional rst files. those files may even be in subdirectories that you can reference using a relative path.
2523

24+
The overview section, which follows is an ideal section to look at both online and at the source. It is pretty easy to see how to write using any of the interactive features just by looking at the examples in ``overview.rst``
2625

27-
SECTION 2: Another Random Section
26+
27+
SECTION 2: An Overview of the extensions
2828
:::::::::::::::::::::::::::::::::
2929

3030
.. toctree::
3131
:maxdepth: 2
3232

33-
morecontent.rst
34-
words.rst
35-
somestuff.rst
36-
MoreThings/apples.rst
33+
overview.rst
34+
35+
36+
SECTION 2: Add more stuff here
37+
:::::::::::::::::::::::::::::::::
38+
39+
You can add more stuff here.
40+
41+
.. morecontent.rst
42+
.. words.rst
43+
.. somestuff.rst
44+
.. MoreThings/apples.rst

0 commit comments

Comments
 (0)