Skip to content

Commit eaeddf2

Browse files
Merge pull request #313 from adamtheturtle/document-dash-b
Document how to build documentation
2 parents c9ef963 + 556c103 commit eaeddf2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,13 @@ Unsupported Notion Block Types
341341
Uploading Documentation to Notion
342342
----------------------------------
343343

344+
Build documentation with the ``notion`` builder.
345+
For eaxmple:
346+
347+
.. code-block:: console
348+
349+
$ sphinx-build -W -b notion source build/notion
350+
344351
After building your documentation with the Notion builder, you can upload it to Notion using the included command-line tool.
345352

346353
Prerequisites
@@ -358,6 +365,7 @@ Usage
358365

359366
.. code-block:: console
360367
368+
# The JSON file will be in the build directory, e.g. ./build/notion/index.json
361369
$ notion-upload --file path/to/output.json --parent-id parent_page_id --parent-type page --title "Page Title" --sha-mapping notion-sha-mapping.json
362370
363371
Arguments:

0 commit comments

Comments
 (0)