Skip to content

Commit 4b31bc4

Browse files
tcadusertcaduser
committed
miscellaneous files
1 parent 221b07d commit 4b31bc4

17 files changed

Lines changed: 2995 additions & 0 deletions

‎devsim_docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = python -msphinx
7+
SPHINXPROJ = TCAD docs
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎devsim_docs/make.bat‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=python -msphinx
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
set SPHINXPROJ=TCAD docs
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
20+
echo.then set the SPHINXBUILD environment variable to point to the full
21+
echo.path of the 'sphinx-build' executable. Alternatively you may add the
22+
echo.Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.http://sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30+
goto end
31+
32+
:help
33+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34+
35+
:end
36+
popd

‎devsim_docs/source/conf.py‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# TCAD docs documentation build configuration file, created by
4+
# sphinx-quickstart on Wed Dec 13 14:03:48 2017.
5+
#
6+
# This file is execfile()d with the current directory set to its
7+
# containing dir.
8+
#
9+
# Note that not all possible configuration values are present in this
10+
# autogenerated file.
11+
#
12+
# All configuration values have a default; values that are commented out
13+
# serve to show the default.
14+
15+
# If extensions (or modules to document with autodoc) are in another directory,
16+
# add these directories to sys.path here. If the directory is relative to the
17+
# documentation root, use os.path.abspath to make it absolute, like shown here.
18+
#
19+
# import os
20+
# import sys
21+
# sys.path.insert(0, os.path.abspath('.'))
22+
23+
24+
# -- General configuration ------------------------------------------------
25+
26+
# If your documentation needs a minimal Sphinx version, state it here.
27+
#
28+
# needs_sphinx = '1.0'
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = ['sphinx.ext.intersphinx',
34+
'sphinx.ext.todo',
35+
'sphinx.ext.mathjax',
36+
'sphinx.ext.ifconfig',
37+
'sphinx.ext.viewcode',
38+
'sphinx.ext.githubpages',
39+
'sphinxcontrib.bibtex',
40+
]
41+
42+
# Add any paths that contain templates here, relative to this directory.
43+
templates_path = ['_templates']
44+
45+
# The suffix(es) of source filenames.
46+
# You can specify multiple suffix as a list of string:
47+
#
48+
# source_suffix = ['.rst', '.md']
49+
source_suffix = '.rst'
50+
51+
# The master toctree document.
52+
master_doc = 'index'
53+
54+
# General information about the project.
55+
project = u'TCAD docs'
56+
copyright = u'2017, Juan Sanchez'
57+
author = u'Juan Sanchez'
58+
59+
# The version info for the project you're documenting, acts as replacement for
60+
# |version| and |release|, also used in various other places throughout the
61+
# built documents.
62+
#
63+
# The short X.Y version.
64+
version = u'0.0'
65+
# The full version, including alpha/beta/rc tags.
66+
release = u'0.0'
67+
68+
# The language for content autogenerated by Sphinx. Refer to documentation
69+
# for a list of supported languages.
70+
#
71+
# This is also used if you do content translation via gettext catalogs.
72+
# Usually you set "language" from the command line for these cases.
73+
language = None
74+
75+
# List of patterns, relative to source directory, that match files and
76+
# directories to ignore when looking for source files.
77+
# This patterns also effect to html_static_path and html_extra_path
78+
exclude_patterns = []
79+
80+
# The name of the Pygments (syntax highlighting) style to use.
81+
pygments_style = 'sphinx'
82+
83+
# If true, `todo` and `todoList` produce output, else they produce nothing.
84+
todo_include_todos = True
85+
86+
87+
# -- Options for HTML output ----------------------------------------------
88+
89+
# The theme to use for HTML and HTML Help pages. See the documentation for
90+
# a list of builtin themes.
91+
#
92+
html_theme = 'alabaster'
93+
94+
# Theme options are theme-specific and customize the look and feel of a theme
95+
# further. For a list of options available for each theme, see the
96+
# documentation.
97+
#
98+
# html_theme_options = {}
99+
100+
# Add any paths that contain custom static files (such as style sheets) here,
101+
# relative to this directory. They are copied after the builtin static files,
102+
# so a file named "default.css" will overwrite the builtin "default.css".
103+
html_static_path = ['_static']
104+
105+
# Custom sidebar templates, must be a dictionary that maps document names
106+
# to template names.
107+
#
108+
# This is required for the alabaster theme
109+
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
110+
html_sidebars = {
111+
'**': [
112+
'about.html',
113+
'navigation.html',
114+
'relations.html', # needs 'show_related': True theme option to display
115+
'searchbox.html',
116+
'donate.html',
117+
]
118+
}
119+
120+
121+
# -- Options for HTMLHelp output ------------------------------------------
122+
123+
# Output file base name for HTML help builder.
124+
htmlhelp_basename = 'TCADdocsdoc'
125+
126+
127+
# -- Options for LaTeX output ---------------------------------------------
128+
129+
latex_elements = {
130+
# The paper size ('letterpaper' or 'a4paper').
131+
#
132+
# 'papersize': 'letterpaper',
133+
134+
# The font size ('10pt', '11pt' or '12pt').
135+
#
136+
# 'pointsize': '10pt',
137+
138+
# Additional stuff for the LaTeX preamble.
139+
#
140+
# 'preamble': '',
141+
'preamble': '''
142+
\\usepackage{mathrsfs}
143+
\\usepackage{mathrsfs}
144+
'''
145+
# Latex figure (float) alignment
146+
#
147+
# 'figure_align': 'htbp',
148+
}
149+
150+
# Grouping the document tree into LaTeX files. List of tuples
151+
# (source start file, target name, title,
152+
# author, documentclass [howto, manual, or own class]).
153+
latex_documents = [
154+
(master_doc, 'TCADdocs.tex', u'TCAD Theory',
155+
u'Juan Sanchez', 'manual'),
156+
]
157+
158+
159+
# -- Options for manual page output ---------------------------------------
160+
161+
# One entry per manual page. List of tuples
162+
# (source start file, name, description, authors, manual section).
163+
man_pages = [
164+
(master_doc, 'TCADdocs', u'TCAD docs Documentation',
165+
[author], 1)
166+
]
167+
168+
169+
# -- Options for Texinfo output -------------------------------------------
170+
171+
# Grouping the document tree into Texinfo files. List of tuples
172+
# (source start file, target name, title, author,
173+
# dir menu entry, description, category)
174+
texinfo_documents = [
175+
(master_doc, 'TCADdocs', u'TCAD docs Documentation',
176+
author, 'TCADdocs', 'One line description of project.',
177+
'Miscellaneous'),
178+
]
179+
180+
181+
182+
# -- Options for Epub output ----------------------------------------------
183+
184+
# Bibliographic Dublin Core info.
185+
epub_title = project
186+
epub_author = author
187+
epub_publisher = author
188+
epub_copyright = copyright
189+
190+
# The unique identifier of the text. This can be a ISBN number
191+
# or the project homepage.
192+
#
193+
# epub_identifier = ''
194+
195+
# A unique identification for the text.
196+
#
197+
# epub_uid = ''
198+
199+
# A list of files that should not be packed into the epub file.
200+
epub_exclude_files = ['search.html']
201+
202+
203+
204+
# Example configuration for intersphinx: refer to the Python standard library.
205+
intersphinx_mapping = {'https://docs.python.org/': None}

0 commit comments

Comments
 (0)