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

Commit 82e2b96

Browse files
committed
Update docs on the build command
1 parent 32721a0 commit 82e2b96

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docker/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ The ``rsmanage`` command will run many useful commands inside the container for
238238
* Add a course - ``rsmanage addcourse``
239239
* Add a user - ``rsmanage adduser``
240240
* Get information about a course ``rsmanage courseinfo``
241-
* Build a book - ``rsmanage build --course bookname``
241+
* Build a book - ``rsmanage build bookname``
242242
* Get a database shell in the current database - ``rsmanage db``
243243

244244
...and many other things. Just type ``rsmanage`` for a list of things it can do. For a list of options just type ``rsmanage`` and the subcommand you want followed by ``--help``; for example, ``rsmanage build --help``.
@@ -252,7 +252,7 @@ No books are installed by default; you must add books using the following proces
252252

253253
.. code-block:: bash
254254
255-
rsmanage build --course thinkcspy --clone https://github.com/RunestoneInteractive/thinkcspy.git
255+
rsmanage build thinkcspy --clone https://github.com/RunestoneInteractive/thinkcspy.git
256256
257257
After cloning a book, you may need to add it to the database. Most of the standard books are already there, but you can use ``rsmanage addcourse`` to add it if needed.
258258

@@ -448,7 +448,7 @@ system. You need to do the following:
448448

449449
#. Run the command ``rsmanage addcourse``. Use the project name you configured in ``pavement.py`` as the name of BOTH the course and the basecourse when it asks.
450450

451-
#. Now that your course is registered, rebuild it using the command ``rsmanage build --course <book_name>`` command.
451+
#. Now that your course is registered, rebuild it using the command ``rsmanage build <book_name>`` command. If this is a PreTeXt book then build with the command ``rsmanage build --ptx <book_name>`` where the ``book_name`` should match the document-id specified in the docinfo section of the pretext book. Often found in ``bookinfo.ptx`` but sometimes as a peer of ``<book>`` in the ``main.ptx`` file for the book.
452452

453453

454454
Changing dependencies

0 commit comments

Comments
 (0)