eriks/erepublik-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Freshening up documentation

Browse Source
This commit is contained in:
Eriks Karls 2019-08-28 17:16:46 +03:00
parent 597d27117c
commit 7573f29950
7 changed files with 52 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@ -7,7 +7,7 @@ eRepublik script
:target: https://pypi.python.org/pypi/erepublik :target: https://pypi.python.org/pypi/erepublik
.. image:: https://readthedocs.org/projects/erepublik_script/badge/?version=latest .. image:: https://readthedocs.org/projects/erepublik_script/badge/?version=latest
:target: https://erepublik_script.readthedocs.io/en/latest/?badge=latest :target: https://erepublik.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status :alt: Documentation Status
@ -15,7 +15,7 @@ Python package for automated eRepublik playing
* Free software: MIT license * Free software: MIT license
* Documentation: https://erepublik.readthedocs.io. * Documentation: https://erepublik.readthedocs.io/en/latest/
Features Features

9
docs/conf.py
View File

@ -23,6 +23,7 @@ import sys
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('..'))
import erepublik import erepublik
import edx_theme
# -- General configuration --------------------------------------------- # -- General configuration ---------------------------------------------
@ -32,7 +33,7 @@ import erepublik
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'edx_theme']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -84,7 +85,8 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'alabaster' html_theme = 'edx_theme'
html_theme_path = [edx_theme.get_html_theme_path()]
# Theme options are theme-specific and customize the look and feel of a # Theme options are theme-specific and customize the look and feel of a
# theme further. For a list of options available for each theme, see the # theme further. For a list of options available for each theme, see the
@ -158,6 +160,3 @@ texinfo_documents = [
'One line description of project.', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

8
docs/installation.rst
View File

@ -32,13 +32,13 @@ You can either clone the public repository:
.. code-block:: console .. code-block:: console
$ git clone git://github.com/eeriks/erepublik_script $ git clone git://github.com/eeriks/erepublik
Or download the `tarball`_: Or download the `tarball`_:
.. code-block:: console .. code-block:: console
$ curl -OL https://github.com/eeriks/erepublik_script/tarball/master $ curl -OL https://github.com/eeriks/erepublik/tarball/master
Once you have a copy of the source, you can install it with: Once you have a copy of the source, you can install it with:
@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
$ python setup.py install $ python setup.py install
.. _Github repo: https://github.com/eeriks/erepublik_script .. _Github repo: https://github.com/eeriks/erepublik
.. _tarball: https://github.com/eeriks/erepublik_script/tarball/master .. _tarball: https://github.com/eeriks/erepublik/tarball/master

72
docs/make.bat
View File

@ -1,36 +1,36 @@
@ECHO OFF @ECHO OFF
pushd %~dp0 pushd %~dp0
REM Command file for Sphinx documentation REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" ( if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx set SPHINXBUILD=python -msphinx
) )
set SOURCEDIR=. set SOURCEDIR=.
set BUILDDIR=_build set BUILDDIR=_build
set SPHINXPROJ=erepublik_script set SPHINXPROJ=erepublik
if "%1" == "" goto help if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL %SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 ( if errorlevel 9009 (
echo. echo.
echo.The Sphinx module was not found. Make sure you have Sphinx installed, echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH. echo.Sphinx directory to PATH.
echo. echo.
echo.If you don't have Sphinx installed, grab it from echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/ echo.http://sphinx-doc.org/
exit /b 1 exit /b 1
) )
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end goto end
:help :help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end :end
popd popd

5
docs/usage.rst
View File

@ -4,4 +4,7 @@ Usage
To use eRepublik script in a project:: To use eRepublik script in a project::
import erepublik from erepublik import Citizen
player = Citizen('email@domain.com', 'password')
player.update_all()

1
requirements_dev.txt
View File

@ -13,3 +13,4 @@ pytz==2019.1
requests==2.22.0 requests==2.22.0
pycryptodome==3.8.2 pycryptodome==3.8.2
python-slugify==2.0.1 python-slugify==2.0.1
edx-sphinx-theme

2
tox.ini
View File

@ -1,5 +1,5 @@
[tox] [tox]
envlist = py36, py37, flake8 envlist = py37, flake8
[travis] [travis]
python = python =