diff --git a/docs/conf.py b/docs/conf.py index 58fd8a3..5f2eadd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,8 +1,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 +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- @@ -12,7 +12,6 @@ import os import sys - sys.path.insert(0, os.path.abspath('../')) @@ -22,11 +21,8 @@ copyright = '2020-2021, Tomas Stolker' author = 'Tomas Stolker' -# -- General configuration --------------------------------------------------- -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' +# -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -39,40 +35,24 @@ 'nbsphinx' ] -# sphinx-automodapi -numpydoc_show_class_members = False - # Disable notebook timeout nbsphinx_timeout = -1 +# Allow errors from notebooks +nbsphinx_allow_errors = True + autoclass_content = 'both' # 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 +templates_path = [] # 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 = ['tutorials/.ipynb_checkpoints/*'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = None +exclude_patterns = ['_build', + 'Thumbs.db', + '.DS_Store', + '.ipynb_checkpoints/*'] # -- Options for HTML output ------------------------------------------------- @@ -82,10 +62,6 @@ # html_theme = 'sphinx_book_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 = { 'path_to_docs': 'docs', 'repository_url': 'https://github.com/tomasstolker/diskmap', @@ -106,98 +82,10 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = [] -# 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 = {} - html_logo = 'logo.png' -html_favicon = 'favicon.png' html_search_language = 'en' html_context = {'display_github': True, 'github_user': 'tomasstolker', 'github_repo': 'diskmap', 'github_version': 'main/docs/'} - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'diskmapdoc' - - -# -- 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, 'diskmap.tex', 'diskmap Documentation', - 'Tomas Stolker', '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, 'diskmap', 'diskmap 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, 'diskmap', 'diskmap Documentation', - author, 'diskmap', 'Scattered light mapping of protoplanetary disks', - '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 ------------------------------------------------- diff --git a/docs/installation.rst b/docs/installation.rst index f414849..ca744c1 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -8,7 +8,7 @@ Installation Installation from PyPI ---------------------- -*diskmap* can be installed with the `pip package manager `_: +*diskmap* can be installed from PyPI with the `pip package manager `_: .. code-block:: console @@ -23,13 +23,27 @@ Or to update the package to the most recent version: Installation from Github ------------------------ -Installation from Github is done by cloning the repository: +Using pip +^^^^^^^^^ + +Installation from Github is also possible with ``pip``: + +.. code-block:: console + + $ pip install git+git://github.com/tomasstolker/diskmap.git + +This will also install the required dependencies. + +Cloning the repository +^^^^^^^^^^^^^^^^^^^^^^ + +Alternatively, the Github repository can be cloned, which is in particular useful if you want to look into and/or make changes to the code .. code-block:: console $ git clone git@github.com:tomasstolker/diskmap.git -And running the setup script to install *diskmap* and its dependencies: +The package is installed by running the setup script: .. code-block:: console diff --git a/docs/make.bat b/docs/make.bat index 2119f51..153be5e 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -21,7 +21,7 @@ if errorlevel 9009 ( echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ + echo.https://www.sphinx-doc.org/ exit /b 1 )