shalvah преди 5 години
родител
ревизия
004870b2d7
променени са 3 файла, в които са добавени 17 реда и са изтрити 14 реда
  1. 0 2
      docs/conf.py
  2. 1 1
      docs/documenting/index.md
  3. 16 11
      docs/index.md

+ 0 - 2
docs/conf.py

@@ -57,8 +57,6 @@ master_doc = 'index'
 # app setup hook
 def setup(app):
     app.add_config_value('recommonmark_config', {
-        'auto_toc_tree_section': 'Contents',
-        'auto_toc_maxdepth': 2,
         'enable_eval_rst': True,
     }, True)
     app.add_transform(AutoStructify)

+ 1 - 1
docs/documenting/index.md

@@ -3,7 +3,7 @@ Scribe tries to infer information about your API from your code, but you can enr
 
 ```eval_rst
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    documenting-api-information
    documenting-endpoint-metadata

+ 16 - 11
docs/index.md

@@ -10,17 +10,22 @@ Generate API documentation for humans from your Laravel/Lumen/[Dingo](https://gi
 ```
 
 ## Contents
-* [Getting started](guide-getting-started.md)
-* [Whats new](whats-new.md)
-* [Migrating from mpociot/laravel-apidoc-generator](migrating.md)
-* [Documenting your API](documenting/index.md)
-* [Generating documentation](generating-documentation.md)
-* [Configuration](config.md)
-* [Troubleshooting and debugging](troubleshooting.md)
-* [Advanced customization](customization.md)
-* [How Scribe works](architecture.md)
-* [Extending functionality with plugins](plugins.md)
-* [Contributing to Scribe](contributing.md)
+```eval_rst
+.. toctree::
+   :maxdepth: 2
+
+   guide-getting-started
+   whats-new
+   migrating
+   documenting/index
+   generating-documentation
+   config
+   troubleshooting
+   customization
+   architecture
+   plugins
+   contributing
+```
 
 ## Installation
 PHP 7.2.5 and Laravel/Lumen 5.8 or higher are required.