sphinx-1-project-initialization

name	sphinx-1-project-initialization
description	Sub-skill of sphinx: 1. Project Initialization (+1).
version	1.0.0
category	development
type	reference
scripts_exempt	true

1. Project Initialization (+1)

1. Project Initialization

# Quick start with sphinx-quickstart
sphinx-quickstart docs

# Answer the prompts:
# > Separate source and build directories (y/n) [n]: y
# > Project name: MyProject
# > Author name(s): Your Name
# > Project release: 1.0.0
# > Project language [en]: en

# Generated structure:
# docs/
# ├── source/
# │   ├── conf.py
# │   ├── index.rst
# │   └── _static/
# │   └── _templates/
# └── build/
#     └── (output files)

# Or manual setup
mkdir -p docs/source docs/build
touch docs/source/conf.py docs/source/index.rst

2. Basic Configuration (conf.py)

# docs/source/conf.py

# -- Project information -----------------------------------------------------
project = 'MyProject'
copyright = '2024-2026, Your Name'
author = 'Your Name'
release = '1.0.0'
version = '1.0'

# -- General configuration ---------------------------------------------------
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.githubpages',
    'sphinx_rtd_theme',
    'sphinx_copybutton',
    'myst_parser',
]

# Source file suffixes
source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

# Master document
master_doc = 'index'

# Exclude patterns
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# Pygments style
pygments_style = 'sphinx'

# -- Options for HTML output -------------------------------------------------
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_logo = '_static/logo.png'
html_favicon = '_static/favicon.ico'

html_theme_options = {
    'logo_only': False,
    'display_version': True,
    'prev_next_buttons_location': ,
    : ,
    : ,
    
    : ,
    : ,
    : ,
    : ,
    : ,
}


autodoc_default_options = {
    : ,
    : ,
    : ,
    : ,
    : ,
    : ,
}

autodoc_typehints = 
autodoc_typehints_description_target = 
autodoc_class_signature = 


napoleon_google_docstring = 
napoleon_numpy_docstring = 
napoleon_include_init_with_doc = 
napoleon_include_private_with_doc = 
napoleon_include_special_with_doc = 
napoleon_use_admonition_for_examples = 
napoleon_use_admonition_for_notes = 
napoleon_use_admonition_for_references = 
napoleon_use_ivar = 
napoleon_use_param = 
napoleon_use_rtype = 
napoleon_use_keyword = 
napoleon_attr_annotations = 


intersphinx_mapping = {
    : (, ),
    : (, ),
    : (, ),
    : (, ),
}


todo_include_todos = 


latex_elements = {
    : ,
    : ,
    : ,
}

latex_documents = [
    (master_doc, , ,
     , ),
]


epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
epub_exclude_files = []