sphinx復旧

勉強用としてPythonのコードドキュメントとして、sphinxを使っていました。

環境はWindows１０
Sphinx v4.0.1
Python3

初学者として学んだことを記録して復習の為に、sphinxでドキュメント化。
しかし、Anacondaに障害が発生し、アンインストールしてから再インストールしたら、Sphinxも削除されてしまいました。
幸い、データはありましたので助かりました。

しかし、中々復旧できない。
Sphinxをどう構築したのか忘れてしまい。
手順を保存しなかったことを後悔しております。

メモとして保存します。

インストール

以下の４つのパッケージをインストールする。
（Anacondaをインストールすることを前提。）

・recommonmark
・nbsphinx
・sphinx_rtd_theme（テーマ）

コマンド実行
ターミナルから以下のコマンドを実行します。

sphinx-quickstart

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

というメッセージが出たので、そのままエンターするが、なぜかエラーになり先に進まない。

検索して調べながら再度実行するのだが何故か、同じメッセージばかり・・

何かのキーを押したら、なぜか、先に進めました。（このような現象は何故か、調べます。）


    Project name：プロジェクト名
    Author name：管理者名
    Project release：リリース番号
    Project language：ja

と入力して完了。

## confy.pyを編集
[Sphinxで超簡単にドキュメント作成をしよう！] ("https://youtu.be/CMyw1tSvb2Y)
これが、分かりやすくて勉強になりました。
confy.pyについても触れています。


```

# -*- 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
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import recommonmark
from recommonmark.transform import AutoStructify
from recommonmark.parser import CommonMarkParser

# -- Project information -----------------------------------------------------

project = 'Sphinx'
copyright = '2019, 名前'
author = '自分の名前'

# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
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',
    'nbsphinx',
    'sphinx.ext.mathjax',
    'sphinx.ext.coverage',
    'sphinx.ext.imgmath'
    
]

# 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_parsers = {
    '.md' : 'recommonmark.parser.CommonMarkParser'
}
# 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 = 'ja'
latex_docclass = {'manual': 'jsbook'}


# 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', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
# import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
# html_theme = "classic"
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# 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 = 'doc'


# -- 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, 'Sphinx.tex', 'Sphinx',
     'Sphinx', '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, 'Sphinx', 'Sphinx 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, 'Sphinx', 'Sphinx Documentation',
     author, 'Sphinx', 'One line description of project.',
     'Miscellaneous'),
]


# -- Extension configuration -------------------------------------------------

index.rstを編集

..  documentation master file, created by
   sphinx-quickstart on Tue Apr 10 18:53:02 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Pythonコードドキュメント
=====================================================================

.. toctree::
   :maxdepth: 3
   :caption: Contents: 
   :glob:
   
   src/ファイル名（拡張子なし）
   src/ファイル名（拡張子なし）
 

以下のコマンドを実行

PS C:\Users\User\Sphinx> make html

htmlファイルが作成される。