Freshening up documentation
This commit is contained in:
Eriks Karls
parent
597d27117c
commit
7573f29950
@ -7,7 +7,7 @@ eRepublik script
|
||||
:target: https://pypi.python.org/pypi/erepublik
|
||||
|
||||
.. 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
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ Python package for automated eRepublik playing
|
||||
|
||||
|
||||
* Free software: MIT license
|
||||
* Documentation: https://erepublik.readthedocs.io.
|
||||
* Documentation: https://erepublik.readthedocs.io/en/latest/
|
||||
|
||||
|
||||
Features
|
||||
|
||||
@ -23,6 +23,7 @@ import sys
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
import erepublik
|
||||
import edx_theme
|
||||
|
||||
# -- General configuration ---------------------------------------------
|
||||
|
||||
@ -32,7 +33,7 @@ import erepublik
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# 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.
|
||||
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
|
||||
# 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 further. For a list of options available for each theme, see the
|
||||
@ -158,6 +160,3 @@ texinfo_documents = [
|
||||
'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
|
||||
|
||||
@ -32,13 +32,13 @@ You can either clone the public repository:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone git://github.com/eeriks/erepublik_script
|
||||
$ git clone git://github.com/eeriks/erepublik
|
||||
|
||||
Or download the `tarball`_:
|
||||
|
||||
.. 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:
|
||||
|
||||
@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
|
||||
$ python setup.py install
|
||||
|
||||
|
||||
.. _Github repo: https://github.com/eeriks/erepublik_script
|
||||
.. _tarball: https://github.com/eeriks/erepublik_script/tarball/master
|
||||
.. _Github repo: https://github.com/eeriks/erepublik
|
||||
.. _tarball: https://github.com/eeriks/erepublik/tarball/master
|
||||
|
||||
@ -1,36 +1,36 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=python -msphinx
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
set SPHINXPROJ=erepublik_script
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
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.path of the 'sphinx-build' executable. Alternatively you may add the
|
||||
echo.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%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||
|
||||
:end
|
||||
popd
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=python -msphinx
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
set SPHINXPROJ=erepublik
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
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.path of the 'sphinx-build' executable. Alternatively you may add the
|
||||
echo.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%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||
|
||||
:end
|
||||
popd
|
||||
|
||||
@ -4,4 +4,7 @@ Usage
|
||||
|
||||
To use eRepublik script in a project::
|
||||
|
||||
import erepublik
|
||||
from erepublik import Citizen
|
||||
player = Citizen('email@domain.com', 'password')
|
||||
player.update_all()
|
||||
|
||||
|
||||
@ -13,3 +13,4 @@ pytz==2019.1
|
||||
requests==2.22.0
|
||||
pycryptodome==3.8.2
|
||||
python-slugify==2.0.1
|
||||
edx-sphinx-theme
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user