Skip to content
Snippets Groups Projects
Commit 889a8a85 authored by Mads M. Pedersen's avatar Mads M. Pedersen
Browse files

add missing documentation files

parent 1c784872
No related branches found
No related tags found
No related merge requests found
# -*- 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/master/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
import sys
sys.path.insert(0, os.path.join(os.path.abspath('.'), '..', '..'))
from py_wake import __version__
from py_wake import __release__
# -- Project information -----------------------------------------------------
project = 'PyWake'
copyright = '2018, DTU Wind Energy'
author = 'DTU Wind Energy'
# The short X.Y version
version = __version__
# The full version, including alpha/beta/rc tags
release = __release__
# -- 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.autosummary',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'nbsphinx_link',
]
# 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 = 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 = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 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 = {
# TOC options
'navigation_depth': 2, # only show 2 levels on left sidebar
'collapse_navigation': False, # don't allow sidebar to collapse
}
# 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 = 'PyWakedoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# 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, 'PyWake.tex', 'PyWake Documentation',
'DTU Wind Energy', '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, 'pywake', 'PyWake 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, 'PyWake', 'PyWake Documentation',
author, 'PyWake', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
\ No newline at end of file
.. PyWake documentation master file, created by
sphinx-quickstart on Mon Dec 3 13:24:21 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyWake
===================
.. toctree::
:caption: User Guide
:maxdepth: 2
installation
tutorials
reference_guide
\ No newline at end of file
.. _installation:
===========================
Installation
===========================
You must first have a working and properly configured Python 3.4+ distribution
on your computer. We often use and highly recommend
`Anaconda <https://www.anaconda.com/download/>`_.
Simple user
------------
If you have other Python programs besides PyWake, it is a good idea to install
each program in its own environment to ensure that the dependencies for the
different packages do not conflict with one another. The commands to create and
then activate an environment in an Anaconda prompt are::
conda create --name pywake python=3.6
activate pywake
You can install PyWake into the current active environment directly from git::
pip install git+https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake.git
Developer
----------
We highly recommend developers install PyWake into its own environment. (See
instructions above.) The commands to clone and install PyWake with developer
options into the current active environment in an Anaconda Prommpt are as
follows::
git clone https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake.git
cd PyWake
pip install -e .
.. _tutorial:
===========================
Tutorials
===========================
WindTurbines_
.. _WindTurbines: https://colab.research.google.com/github/DTUWindEnergy/PyWake/blob/master/tutorials/windturbines.ipynb
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment