mirror of
https://github.com/clearml/wexpect-venv
synced 2025-04-07 06:14:00 +00:00
[ADD] First draft of the doc
This commit is contained in:
parent
0473d4b3e9
commit
f91da266e6
20
doc/Makefile
Normal file
20
doc/Makefile
Normal file
@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
35
doc/make.bat
Normal file
35
doc/make.bat
Normal file
@ -0,0 +1,35 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
55
doc/source/conf.py
Normal file
55
doc/source/conf.py
Normal file
@ -0,0 +1,55 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'wexpect'
|
||||
copyright = '2020, Benedek Racz'
|
||||
author = 'Benedek Racz'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '0.0.1'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
71
doc/source/index.rst
Normal file
71
doc/source/index.rst
Normal file
@ -0,0 +1,71 @@
|
||||
Wexpect version |version|
|
||||
=========================
|
||||
|
||||
.. image:: https://ci.appveyor.com/api/projects/status/tbji72d5s0tagrt9?svg=true
|
||||
:target: https://ci.appveyor.com/project/raczben/wexpect
|
||||
:align: right
|
||||
:alt: Build status
|
||||
|
||||
*Wexpect* is a Windows variant of `Pexpect <https://pexpect.readthedocs.io/en/stable/>`_
|
||||
Wexpect and Pexpect makes Python a better tool for controlling other applications.
|
||||
|
||||
Wexpect is a Python module for spawning child applications;
|
||||
controlling them; and responding to expected patterns in their output.
|
||||
Wexpect works like Don Libes' Expect. Wexpect allows your script to
|
||||
spawn a child application and control it as if a human were typing
|
||||
commands.
|
||||
|
||||
Wexpect can be used for automating interactive applications such as
|
||||
ssh, ftp, passwd, telnet, etc. It can be used to a automate setup
|
||||
scripts for duplicating software package installations on different
|
||||
servers. It can be used for automated software testing.
|
||||
Wexpect highly depends on Mark Hammond's `pywin32 <https://github.com/mhammond/pywin32>`_
|
||||
which provides access to many of the Windows APIs from Python.
|
||||
|
||||
Install
|
||||
^^^^^^^
|
||||
|
||||
Wexpect is on PyPI, and can be installed with standard tools::
|
||||
|
||||
pip install wexpect
|
||||
|
||||
Usage
|
||||
^^^^^
|
||||
|
||||
To interract with a child process use :code:`spawn` method:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import wexpect
|
||||
child = wexpect.spawn('cmd.exe')
|
||||
child.expect('>')
|
||||
child.sendline('ls')
|
||||
child.expect('>')
|
||||
print(child.before)
|
||||
child.sendline('exit')
|
||||
|
||||
|
||||
For more information see [examples](./examples) folder.
|
||||
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
overview
|
||||
api/index
|
||||
examples
|
||||
FAQ
|
||||
commonissues
|
||||
history
|
||||
|
||||
Wexpect is developed `on Github <http://github.com/raczben/wexpect>`_. Please
|
||||
report `issues <https://github.com/raczben/wexpect/issues>`_ there as well.
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
Loading…
Reference in New Issue
Block a user