Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Getting Started and Customizing the look and feel. #21

Merged
merged 5 commits into from
Apr 18, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified _static/basic_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _static/fancy_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions custom_look.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ moves the vertical navigation panels to the right side of the page::
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
{% block sidebar2 %}{% endblock %}

Lastly, we need to modify the html theme in :file:`sampledoc/conf.py`::

html_theme = 'sphinxdoc'

Once you rebuild the site with a ``make html`` and reload the page in your browser, you should see a fancier site that looks like this

.. image:: _static/fancy_screenshot.png
6 changes: 3 additions & 3 deletions getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,14 @@ When you reload the page by refreshing your browser pointing to
"Getting Started" docs, and in there this page with the screenshot.
`Voila!`

Note we used the image directive to include to the screenshot above
We can also use the image directive in :file:`index.rst` to include to the screenshot above
with::

.. image:: _static/basic_screenshot.png
.. image::
_static/basic_screenshot.png


Next we'll customize the look and feel of our site to give it a logo,
some custom css, and update the navigation panels to look more like
the `sphinx <http://sphinx.pocoo.org/>`_ site itself -- see
:ref:`custom_look`.