Updated docs and project structure, dumped to 0.1.1

.gitignore

@@ -3,3 +3,5 @@ __pycache__
 /*.egg-info
 /dist
 /.spyproject
+/build
+/docs/_build

LICENSE.txt

@@ -1,5 +1,6 @@
-# The MIT License (MIT)
-Copyright (C) 2018 Thomas Touhey <<thomas@touhey.fr>>
+The MIT License (MIT)
+
+Copyright (C) 2018 Thomas Touhey <thomas@touhey.fr>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the “Software”), to deal

MANIFEST.in

@@ -0,0 +1,10 @@
+include README.rst
+include LICENSE.txt
+include MANIFEST.in
+include setup.py
+include setup.cfg
+
+include docs/*.rst
+include docs/conf.py
+include docs/Makefile
+include docs/make.bat

README.rst

@@ -1,8 +1,9 @@
 Planète Casio's textout() BBcode markup language translator
 ===========================================================
 
-For more information, read the documentation accessible on
-`the official website`_.
+This module contains a BBcode to HTML translator for
+`Planète Casio`_. For more information, read the
+documentation accessible on `the official website`_.
 
 .. warning::
 
@@ -29,6 +30,7 @@ What is left to do
 - Look for security flaws (we really don't want stored XSS flaws!).
 - Manage keywords with tags such as ``[tag key=value other="something else"]``.
 
+.. _Planète Casio:: https://www.planet-casio.com/
 .. _Planète Casio's forge:: https://gitea.planet-casio.com/
 .. _Thomas' forge_:: https://forge.touhey.fr/pc/textout.git
 .. _the official website:: https://textout.touhey.fr/

docs/Makefile

@@ -5,8 +5,8 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = textoutpc
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

docs/conf.py

@@ -39,7 +39,6 @@ release = ''
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.viewcode',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -64,7 +63,7 @@ language = None
 # 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 = []
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -153,7 +152,4 @@ texinfo_documents = [
     (master_doc, 'textoutpc', 'textoutpc Documentation',
      author, 'textoutpc', 'One line description of project.',
      'Miscellaneous'),
-]
-
-
-# -- Extension configuration -------------------------------------------------
+]

docs/index.rst

@@ -1,5 +1,7 @@
-textoutpc, a BBcode markup language translator for Planète Casio
-================================================================
+Welcome to textoutpc's documentation!
+=====================================
+
+textoutpc is a BBcode markup language translator project for `Planète Casio`_.
 
 BBcode has been invented in the 90s/2000s for bulletin board systems.
 It has been implemented in `Planète Casio`_ during its first years (although
@@ -19,8 +21,8 @@ As this is a rewrite, the vulnerabilities and bug will not be common to this
 project and the online version of the transcoder.
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+	:maxdepth: 2
+	:caption: Contents:
 
 	language
 	usage

docs/make.bat

@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=source
-set BUILDDIR=build
+set SOURCEDIR=.
+set BUILDDIR=_build
 set SPHINXPROJ=textoutpc
 
 if "%1" == "" goto help

setup.cfg

@@ -25,12 +25,15 @@ packages = find:
 test_suite = test
 scripts =
   scripts/textout2html
-  scripts/textout2lightscript
+  scripts/textout2ls
 install_requires =
   regex
 
 [options.package_data]
 * = *.txt, *.rst
 
+[build_sphinx]
+source-dir = doc
+
 [wheel]
 universal = True

setup.py

@@ -5,10 +5,11 @@
 #******************************************************************************
 """ Setup script for the textoutpc Python package and script. """
 
-from setuptools import setup
+from sphinx.setup_command import BuildDoc as _BuildDoc
+from setuptools import setup as _setup
 
 # Actually, most of the project's data is read from the `setup.cfg` file.
 
-setup()
+_setup(cmdclass = {'build_sphinx': _BuildDoc})
 
 # End of file.

textoutpc/__init__.py

@@ -12,7 +12,7 @@ from .translate import Translator as _Translator
 
 __all__ = ["version", "tohtml", "tolightscript"]
 
-version = "0.1"
+version = "0.1.1"
 
 def tohtml(message, **tweaks):
 	""" Converts textout BBcode to HTML.