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

New Ansible style docs layout #2415

Merged
merged 5 commits into from
Oct 28, 2019
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
6 changes: 3 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*******
History
*******
*********
Changelog
*********

Unreleased
==========
Expand Down
11 changes: 7 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
********
Molecule
********
****************
Ansible Molecule
****************

.. image:: https://badge.fury.io/py/molecule.svg
:target: https://badge.fury.io/py/molecule
Expand All @@ -10,7 +10,7 @@ Molecule
:target: https://molecule.readthedocs.io/en/stable/
:alt: Documentation Status

.. image:: https://img.shields.io/travis/com/ansible/molecule/master.svg?label=Linux%20builds%20%40%20Travis%20CI
.. image:: https://img.shields.io/travis/com/ansible/molecule/master.svg?label=CI
:target: https://travis-ci.com/ansible/molecule

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
Expand All @@ -29,6 +29,9 @@ Molecule
:target: LICENSE
:alt: Repository License

About Ansible Molecule
======================

Molecule is designed to aid in the development and testing of
`Ansible`_ roles.

Expand Down
7 changes: 6 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,12 @@
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
html_theme_options = {'analytics_id': 'UA-128382387-1'}
html_theme_options = {
'collapse_navigation': False,
'analytics_id': 'UA-128382387-1',
'style_nav_header_background': 'white',
'style_external_links': True,
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
Expand Down
6 changes: 3 additions & 3 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
********
Examples
********
*************************
Common Molecule Use Cases
*************************

.. _docker-usage-example:

Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
Getting Started Guide
*********************

If you're looking to move a little faster, see the :ref:`quick-start`.

The following guide will step through an example of developing and testing a
new Ansible role. After reading this guide, you should be familiar with the
basics of how to use Molecule and what it can offer.
Expand Down
72 changes: 53 additions & 19 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,61 @@
.. include:: ../README.rst
:end-before: _documentation

Contents:
=========
Installation, Upgrade & Porting
===============================

.. toctree::
:maxdepth: 3

installation
getting-started
usage
examples
configuration
testing
contributing
development
changelog
authors
faq

Indices and tables
:maxdepth: 1

Installation Guide <installation>
Upgrade Guide <upgrade>
Porting Guide <porting>

Using Molecule
==============

.. toctree::
:maxdepth: 1

Quickstart Guide <quick-start>
Getting Started Guide <getting-started>
Command Line Reference <usage>
Configuration Guide <configuration>

Common Molecule Use Cases
=========================

.. toctree::
:maxdepth: 1

Common Use Cases <examples>
Frequently Asked Questions <faq>

Contributing to Molecule
========================

.. toctree::
:maxdepth: 1

Contribution Guide <contributing>
Developer Testing Guide <testing>
Developer Release Guide <development>
Credits <authors>

Extending Molecule
==================

TODO.

References and Appendices
=========================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Roadmaps
========

.. toctree::
:maxdepth: 1

Changelog <changelog>
7 changes: 7 additions & 0 deletions docs/quick-start.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _quick-start:

*****************
Quick Start Guide
*****************

TODO.
7 changes: 7 additions & 0 deletions docs/upgrade.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _upgrade:

*************
Upgrade Guide
*************

TODO.
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Usage
=====
Command Line Reference
======================

Check
^^^^^
Expand Down
12 changes: 12 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,18 @@ commands =
extras =
docs

[testenv:doc-livereload]
description = Invoke sphinx-autobuild to build and reload the HTML docs
basepython = {[testenv:doc]basepython}
passenv = {[testenv:doc]passenv}
usedevelop = {[testenv:doc]usedevelop}
commands =
python -m sphinx_autobuild docs/ "{toxworkdir}/docs_out"
deps =
sphinx-autobuild>=0.7.1,<1.0
extras =
docs

[testenv:dockerfile]
description = Tests validity of embedded Dockerfile template used by docker driver
commands =
Expand Down