Browse Source

Add changelog in docs

dave/xdcc
dave 5 years ago
parent
commit
a73bc9ca00
  1. 2
      docs/builder/Dockerfile
  2. 9
      docs/changelog.rst
  3. 7
      docs/conf.py
  4. 10
      docs/index.rst

2
docs/builder/Dockerfile

@ -3,7 +3,7 @@ FROM ubuntu:xenial
RUN apt-get update ; \
apt-get install -y python3 python3-sphinx python3-setuptools python3-dev python3-requests python3-pip python3-lxml make wget unzip libmysqlclient-dev
RUN pip3 install pytz praw
RUN pip3 install pytz praw releases
RUN cd /tmp ; \
wget https://github.com/jgarzik/python-bitcoinrpc/archive/master.zip ; \

9
docs/changelog.rst

@ -0,0 +1,9 @@
=========
Changelog
=========
* :release:`4.1.0 <2017-03-28>`
* :support:`-` Added a changelog
* :feature:`-` Dropped use of deprecated asynchat in favor of asyncio - Python 3.5+ now required.
* :support:`-` Minor docs cleanup
* :feature:`-` Upgraded docker base image to ubuntu:xenial

7
docs/conf.py

@ -35,6 +35,7 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'releases'
]
# Add any paths that contain templates here, relative to this directory.
@ -60,7 +61,7 @@ copyright = '2015, dpedu'
# The short X.Y version.
version = '3.4'
# The full version, including alpha/beta/rc tags.
import pyircbot
import pyircbot
release = pyircbot.PyIRCBot.version
# The language for content autogenerated by Sphinx. Refer to documentation
@ -268,3 +269,7 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
# Options for releases plugin
releases_release_uri = "http://gitlab.davepedu.com/dave/pyircbot3/tags/%s"
releases_issue_uri = "http://gitlab.davepedu.com/dave/pyircbot3/issues/%s"

10
docs/index.rst

@ -1,23 +1,19 @@
.. pyircbot3 documentation master file, created by
sphinx-quickstart on Thu Oct 2 12:02:45 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
PyIRCBot3 - A minimalist and modular IRC bot
============================================
PyIRCBot is a fault tolerant, multi-threaded, modular IRC bot designed for
Python 3.
Python 3.
Contents:
.. toctree::
:maxdepth: 2
setup/_setup.rst
modules/_modules.rst
rpc/_rpc.rst
module_guide/_module_guide.rst
changelog.rst
More Information
================

Loading…
Cancel
Save