Skip to content

Commit 64983cd

Browse files
committed
docs: document source_dir
1 parent 86921b3 commit 64983cd

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ argument:
101101
'language' => 'en', // Could be 'fr'
102102
'build_dir' => __DIR__ . '/build',
103103
'cache_dir' => __DIR__ . '/cache',
104+
'source_dir' => '/path/to/repository/',
104105
'remote_repository' => new GitHubRemoteRepository('username/repository', '/path/to/repository'),
105106
'default_opened_level' => 2,
106107
]);
@@ -135,8 +136,9 @@ And here is how you can configure different versions:
135136
'versions' => $versions,
136137
'title' => 'yourlib API',
137138
'language' => 'en', // Could be 'fr'
138-
'build_dir' => __DIR__.'/../build/sf2/%version%',
139-
'cache_dir' => __DIR__.'/../cache/sf2/%version%',
139+
'build_dir' => __DIR__ . '/../build/sf2/%version%',
140+
'cache_dir' => __DIR__ . '/../cache/sf2/%version%',
141+
'source_dir' => dirname($dir) . '/',
140142
'remote_repository' => new GitHubRemoteRepository('yourorg/yourlib', dirname($dir)),
141143
'default_opened_level' => 2,
142144
]);
@@ -166,7 +168,7 @@ Now that we have a configuration file, let's generate the API documentation:
166168

167169
.. code-block:: bash
168170
169-
$ php doctum.phar update /path/to/config.php
171+
$ doctum.phar update /path/to/config.php
170172
171173
The generated documentation can be found under the configured ``build/``
172174
directory (note that the client side search engine does not work on Chrome due
@@ -182,7 +184,7 @@ if you add the ``-v`` option:
182184

183185
.. code-block:: bash
184186
185-
$ php doctum.phar update /path/to/config.php -v
187+
$ doctum.phar update /path/to/config.php -v
186188
187189
Creating a Theme
188190
----------------

0 commit comments

Comments
 (0)