Browse Source

Fix rst blocks

shalvah 5 years ago
parent
commit
677959c528
3 changed files with 10 additions and 5 deletions
  1. 4 3
      docs/conf.py
  2. 4 1
      docs/documenting-endpoint-responses.md
  3. 2 1
      docs/migrating.md

+ 4 - 3
docs/conf.py

@@ -65,10 +65,11 @@ def setup(app):
 # Syntax highlighting
 # Syntax highlighting
 pygments_style = 'sphinx'
 pygments_style = 'sphinx'
 
 
-# adding PhpLexer
+
+# Gpt this whole section from https://github.com/oroinc/documentation/blob/master/conf.py
+# Needed to make PHP syntax highlighting work well
 from sphinx.highlighting import lexers
 from sphinx.highlighting import lexers
 from pygments.lexers.web import PhpLexer
 from pygments.lexers.web import PhpLexer
-
-# enable highlighting for PHP code not between ``<?php ... ?>`` by default
+# Enable highlighting for PHP code not between ``<?php ... ?>`` by default
 lexers['php'] = PhpLexer(startinline=True)
 lexers['php'] = PhpLexer(startinline=True)
 lexers['php-annotations'] = PhpLexer(startinline=True)
 lexers['php-annotations'] = PhpLexer(startinline=True)

+ 4 - 1
docs/documenting-endpoint-responses.md

@@ -173,7 +173,10 @@ public function listMoreUsers()
 
 
 Scribe will generate an instance (or instances) of the model and pass the model(s) to the resource transformer to get the example response.
 Scribe will generate an instance (or instances) of the model and pass the model(s) to the resource transformer to get the example response.
 
 
-> 💡 TIP: To understand how Scribe generates an instance of your model and how you can customize that, you should check out the section on [How model instances are generated](#how-model-instances-are-generated).
+
+```eval_rst
+.. Tip:: To understand how Scribe generates an instance of your model and how you can customize that, you should check out the section on [How model instances are generated](#how-model-instances-are-generated).
+```
 
 
 ### Pagination
 ### Pagination
 If your endpoint passes paginated results to the resource, you can tell Scribe to paginate by using the `paginate` attribute on `@apiResourceModel`.
 If your endpoint passes paginated results to the resource, you can tell Scribe to paginate by using the `paginate` attribute on `@apiResourceModel`.

+ 2 - 1
docs/migrating.md

@@ -27,7 +27,8 @@ If you've modified your generated Blade views, you should also publish the new o
 php artisan vendor:publish --provider="Knuckles\Scribe\ScribeServiceProvider" --tag=scribe-views
 php artisan vendor:publish --provider="Knuckles\Scribe\ScribeServiceProvider" --tag=scribe-views
 ```
 ```
 
 
-``` important:: If you've modified the generated Markdown or added prepend/append files, you should copy them to a separate folder (not in `resources/docs`). After generating the new docs, you'll have to manually add your changes in.
+```eval_rst
+.. Important:: If you've modified the generated Markdown or added prepend/append files, you should copy them to a separate folder (not in `resources/docs`). After generating the new docs, you'll have to manually add your changes in.
 ```
 ```
 
 
 _After you've done all of the above_, delete your `resources/docs/` and `public/docs` folders, to prevent any conflicts with the new ones we'll generate. If you're using `laravel` type output, you can also delete `resources/views/apidoc/`.
 _After you've done all of the above_, delete your `resources/docs/` and `public/docs` folders, to prevent any conflicts with the new ones we'll generate. If you're using `laravel` type output, you can also delete `resources/views/apidoc/`.