Skip to content

Commit

Permalink
docs: disable manpages, add asciinema to html
Browse files Browse the repository at this point in the history
  • Loading branch information
charego committed Apr 25, 2020
1 parent 713cedd commit 85ff7f8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions cmake/Docs.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ add_feature_info(Documentation INSTALL_DOCS "user manual and documentation")
if(BUILD_DOCS)
configure_file("${SPHINX_SRC_DIR}/conf.py" "${SPHINX_BUILD_DIR}/conf.py" @ONLY)
add_custom_target(doc ALL
DEPENDS sphinx-docs sphinx-manpages)
DEPENDS sphinx-docs)

# Group docs targets into a DocsTargets folder
set_property(TARGET doc sphinx-docs sphinx-manpages
set_property(TARGET doc sphinx-docs
PROPERTY FOLDER cmake/DocTargets)

elseif(HAVE_PREBUILT_DOCS)
Expand Down
2 changes: 1 addition & 1 deletion doc_src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def setup(app):
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ["sphinxcontrib.asciinema"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down
2 changes: 2 additions & 0 deletions doc_src/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ If you want to make your command line more productive, more useful, and more fun
Getting started
---------------

.. asciinema:: 261648

Once installed, just type in ``fish`` into your current shell to try it out!

You will be greeted by the standard fish prompt,
Expand Down

0 comments on commit 85ff7f8

Please sign in to comment.