Commit 01375eca authored by Nathan/Eilisha Shiraini's avatar Nathan/Eilisha Shiraini
Browse files

Preparing for Sphinx and CI

parent 98b597ec
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config
# -- 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.path
import sys
sys.path.insert(0, os.path.abspath('.'))
import uuid
import info
# -- Project information -----------------------------------------------------
project = info.PROJECT_NAME
copyright = info.COPYRIGHT_NOTICE
author = info.AUTHOR_NAME
# The short X.Y version
version = info.VERSION_MAIN
# The full version, including alpha/beta/rc tags
release = info.VERSION
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# 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.doctest',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
# 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 = ['_build', 'build', 'dist', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
# -- 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 = 'sphinx_rtd_theme'
# 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
# documentation.
#
# html_theme_options = {}
# 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']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'ColorCode Documentation'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'ColorCode.tex', 'ColorCode Documentation',
'Nathan/Eilisha \\textsc{Shiraini}', 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'openpgpy', 'ColorCode Documentation',
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'ColorCode', 'ColorCode Documentation',
author, 'ColorCode', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
epub_identifier = info.PROJECT_URL
# A unique identification for the text.
#
epub_uid = str(uuid.uuid4())
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
\ No newline at end of file
import subprocess
import os
# Main project data
PROJECT_NAME = "ColorCode"
PROJECT_URL = 'https://git.heptacle.fr/neshiraini/colorcode'
PROJECT_DESC = "Using Python to make multi-colored 2D codes!"
AUTHOR_NAME = "Nathan/Eilisha Shiraini"
AUTHOR_EMAIL = "neshiraini+colorcode@heptacle.fr"
COPYRIGHT_NOTICE = "(c) 2018 Nathan/Eilisha Shiraini\n(c) 2018 HEPTACLE"
#Versionning data
VERSION_MAIN = '0.0'
VERSION_SUFFIX = '.0'
VERSION_EPOCH = 0
# Git-extracted data
GIT_CURRENT_COUNT = os.environ.get('CI_PIPELINE_ID', subprocess.check_output(['git', 'rev-list', '--count', 'HEAD']).decode('ascii').strip())
GIT_CURRENT_COMMIT = os.environ.get('CI_COMMIT_SHA', subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD']).decode('ascii').strip())
GIT_CURRENT_BRANCH = os.environ.get('CI_COMMIT_REF_SLUG', subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD']).decode('ascii').strip())
# Generated data
VERSION = {
'master' : (str(VERSION_EPOCH) + '!' if VERSION_EPOCH else '') + VERSION_MAIN + VERSION_SUFFIX + '.dev' + GIT_CURRENT_COUNT,
'release' : (str(VERSION_EPOCH) + '!' if VERSION_EPOCH else '') + VERSION_MAIN + VERSION_SUFFIX,
}.get(
GIT_CURRENT_BRANCH,
(str(VERSION_EPOCH) + '!' if VERSION_EPOCH else '') + VERSION_MAIN + VERSION_SUFFIX + '+' + (GIT_CURRENT_BRANCH if GIT_CURRENT_BRANCH else GIT_CURRENT_COMMIT)
)
......@@ -2,6 +2,8 @@ from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext
from Cython.Build import cythonize
import info
copt = {
'msvc': ['/std:c++17', '/O2', '/permissive-'],
'mingw32' : ['-std=c++17', '-O3', '-pedantic'],
......@@ -53,14 +55,19 @@ CYTHON_MODULES = [
setup(
name = "colorcode",
version = "0",
version = info.VERSION,
description = info.PROJECT_DESC,
url = info.PROJECT_URL,
author = info.AUTHOR_NAME,
author_email = info.AUTHOR_EMAIL,
packages = [
"colorcode",
],
description = "Multi-channel Aztec codes",
ext_modules = cythonize(CYTHON_MODULES),
cmdclass = {'build_ext': build_ext_subclass },
setup_requires = [
"Cython",
],
zip_safe = False,
)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment