Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidMercier committed Oct 31, 2023
1 parent 94c1a59 commit fd2b9ea
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 10 deletions.
24 changes: 14 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

import sys
import os
import shlex
#import sphinx_bootstrap_theme

# If extensions (or modules to document with autodoc) are in another directory,
Expand All @@ -29,8 +30,10 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
extensions = [
'sphinx.ext.mathjax',
'sphinx.ext.doctest',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -48,6 +51,7 @@
# General information about the project.
project = u'TriDiMap toolbox'
copyright = u'2014 MERCIER David'
author = u'David Mercier'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -60,7 +64,7 @@

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -105,12 +109,12 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# See http://sphinx-doc.org/theming.html
html_theme = 'default'
#html_theme = 'default'
#html_theme = 'classic'
#html_theme = 'alabaster'
#html_theme = 'agogo'
#html_theme = 'traditional'
#html_theme = 'pyramid'
html_theme = 'pyramid'
#html_theme = 'sphinxdoc'
#html_theme = 'nature' # no option !
#html_theme_options{}
Expand All @@ -130,13 +134,13 @@
# app.add_stylesheet('theme_overrides.css')
#else:
# Override default css to get a larger width for ReadTheDoc build
html_context = {
'css_files': [
'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
'_static/theme_overrides.css',
],
}
# html_context = {
# 'css_files': [
# 'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
# 'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
# '_static/theme_overrides.css',
# ],
# }

# 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
Expand Down
35 changes: 35 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# -*- coding: utf-8 -*-
import codecs
from setuptools import find_packages
from setuptools import setup


setup(
name='TriDiMap_doc-build',
version='3.0',
author='David Mercier',
author_email='david9684@gmail.com',
url='https://tridimap.readthedocs.io',
license='GPL',
description='Build infrastructure for TriDiMap toolbox',
packages=find_packages(),
include_package_data=True,
long_description=codecs.open("README.rst", "r", "utf-8").read(),
install_requires=[
"PyYAML>=3.0",
"Sphinx>=1.5.2",
"Docutils",
"readthedocs-sphinx-ext",
"recommonmark",
"click>=4.0",
"virtualenv",
"six",
"mock"
],
entry_points={
'console_scripts': [
'rtd-build=readthedocs_build.cli:main',
]
},
zip_safe=True,
)

0 comments on commit fd2b9ea

Please sign in to comment.