Add screenshots to getting started docs

humitos/integrations/handle-error-codes
David Fischer 2018-10-01 14:42:40 -07:00
parent ee7aa3ce14
commit b348c0459b
No known key found for this signature in database
GPG Key ID: F0C9B0ADA737AB60
8 changed files with 17 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 212 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

View File

@ -71,7 +71,7 @@ locale_dirs = [
gettext_compact = False
html_theme = 'sphinx_rtd_theme'
# html_static_path = ['_static']
html_static_path = ['_static']
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_logo = 'img/logo.svg'
html_theme_options = {

Binary file not shown.

Before

Width:  |  Height:  |  Size: 958 KiB

View File

@ -46,6 +46,13 @@ and starts a development server to browse your documentation.
Open up http://127.0.0.1:8000/ in your web browser to see your documentation.
You can make changes to your Markdown files and your docs will automatically rebuild.
.. figure:: ../_static/images/first-steps/mkdocs-hello-world.png
:align: right
:figwidth: 300px
:target: ../_static/images/first-steps/mkdocs-hello-world.png
Your MkDocs project is built
Once you have your documentation in a public repository such as GitHub, Bitbucket, or GitLab,
you can start using Read the Docs by :doc:`importing your docs </intro/import-guide>`.

View File

@ -75,6 +75,13 @@ Your ``index.rst`` has been built into ``index.html``
in your documentation output directory (typically ``_build/html/index.html``).
Open this file in your web browser to see your docs.
.. figure:: ../_static/images/first-steps/sphinx-hello-world.png
:align: right
:figwidth: 300px
:target: ../_static/images/first-steps/sphinx-hello-world.png
Your Sphinx project is built
Edit your files and rebuild until you like what you see, then commit your changes and push to your public repository.
Once you have Sphinx documentation in a public repository, you can start using Read the Docs
by :doc:`importing your docs </intro/import-guide>`.

View File

@ -15,9 +15,10 @@ these properties, and the click **Next** to
.. _Import: https://readthedocs.org/dashboard/import
.. figure:: /img/first-steps/import-a-repository.png
.. figure:: ../_static/images/first-steps/import-a-repository.png
:align: right
:figwidth: 300px
:target: ../_static/images/first-steps/import-a-repository.png
Importing a repository