diff --git a/docs/_static/images/first-steps/import-a-repository.png b/docs/_static/images/first-steps/import-a-repository.png new file mode 100644 index 000000000..252f69834 Binary files /dev/null and b/docs/_static/images/first-steps/import-a-repository.png differ diff --git a/docs/_static/images/first-steps/mkdocs-hello-world.png b/docs/_static/images/first-steps/mkdocs-hello-world.png new file mode 100644 index 000000000..0c1bde0bf Binary files /dev/null and b/docs/_static/images/first-steps/mkdocs-hello-world.png differ diff --git a/docs/_static/images/first-steps/sphinx-hello-world.png b/docs/_static/images/first-steps/sphinx-hello-world.png new file mode 100644 index 000000000..cc7639664 Binary files /dev/null and b/docs/_static/images/first-steps/sphinx-hello-world.png differ diff --git a/docs/conf.py b/docs/conf.py index 71d66d0a8..1cb99137f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 = { diff --git a/docs/img/first-steps/import-a-repository.png b/docs/img/first-steps/import-a-repository.png deleted file mode 100644 index 5dba01e69..000000000 Binary files a/docs/img/first-steps/import-a-repository.png and /dev/null differ diff --git a/docs/intro/getting-started-with-mkdocs.rst b/docs/intro/getting-started-with-mkdocs.rst index 322414acb..04b09f945 100644 --- a/docs/intro/getting-started-with-mkdocs.rst +++ b/docs/intro/getting-started-with-mkdocs.rst @@ -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 `. diff --git a/docs/intro/getting-started-with-sphinx.rst b/docs/intro/getting-started-with-sphinx.rst index 054e8f5c9..ff73f75a3 100644 --- a/docs/intro/getting-started-with-sphinx.rst +++ b/docs/intro/getting-started-with-sphinx.rst @@ -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 `. diff --git a/docs/intro/import-guide.rst b/docs/intro/import-guide.rst index 3ee45ebee..b44cdfe4d 100644 --- a/docs/intro/import-guide.rst +++ b/docs/intro/import-guide.rst @@ -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