Skip to content

Commit aa50501

Browse files
committed
fix intersphinx and myst_parser
1 parent bafd2a3 commit aa50501

File tree

3 files changed

+22
-31
lines changed

3 files changed

+22
-31
lines changed

docs/source/conf.py

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,49 +3,36 @@
33
# This file only contains a selection of the most common options. For a full
44
# list see the documentation:
55
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6-
7-
# -- Path setup --------------------------------------------------------------
8-
9-
# If extensions (or modules to document with autodoc) are in another directory,
10-
# add these directories to sys.path here. If the directory is relative to the
11-
# documentation root, use os.path.abspath to make it absolute, like shown here.
12-
#
13-
# import os
14-
# import sys
15-
# sys.path.insert(0, os.path.abspath('.'))
16-
6+
from datetime import datetime
177

188
# -- Project information -----------------------------------------------------
199

2010
project = 'printree'
21-
copyright = '2020, Christian López Barrón'
11+
copyright = f'{datetime.now().year}, Christian López Barrón'
2212
author = 'Christian López Barrón'
2313

2414
# The full version, including alpha/beta/rc tags
25-
release = '0.1.0'
15+
release = '0.2.1'
2616

2717

2818
# -- General configuration ---------------------------------------------------
2919

3020
# Add any Sphinx extension module names here, as strings. They can be
3121
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3222
# ones.
33-
extensions = ['sphinx.ext.autodoc',
34-
'sphinx.ext.doctest',
35-
'sphinx.ext.intersphinx',
36-
# 'sphinx.ext.todo',
37-
# 'sphinx.ext.coverage',
38-
# 'sphinx.ext.imgmath',
39-
# 'sphinx.ext.ifconfig',
40-
'sphinx.ext.viewcode',
41-
# 'sphinx.ext.githubpages',
42-
'sphinx.ext.graphviz',
43-
'sphinx.ext.inheritance_diagram',
44-
'm2r2',
45-
'sphinx_autodoc_typehints']
23+
extensions = [
24+
'sphinx.ext.autodoc',
25+
'sphinx.ext.doctest',
26+
'sphinx.ext.intersphinx',
27+
'sphinx.ext.viewcode',
28+
'sphinx.ext.graphviz',
29+
'sphinx.ext.inheritance_diagram',
30+
'myst_parser',
31+
'sphinx_autodoc_typehints',
32+
]
4633

4734
# Add any paths that contain templates here, relative to this directory.
48-
templates_path = ['_templates']
35+
# templates_path = ['_templates']
4936

5037
# List of patterns, relative to source directory, that match files and
5138
# directories to ignore when looking for source files.
@@ -64,6 +51,8 @@
6451
# Add any paths that contain custom static files (such as style sheets) here,
6552
# relative to this directory. They are copied after the builtin static files,
6653
# so a file named "default.css" will overwrite the builtin "default.css".
67-
html_static_path = ['_static']
54+
# html_static_path = ['_static']
6855

69-
intersphinx_mapping = {'https://docs.python.org/3': None}
56+
intersphinx_mapping = {
57+
'python': ('https://docs.python.org/3', None),
58+
}

docs/source/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
:maxdepth: 2
88
:caption: Contents:
99

10-
.. mdinclude:: ../../README.md
10+
.. include:: ../../README.md
11+
:parser: myst_parser.sphinx_
12+
1113

1214
Module contents
1315
---------------

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ classifiers =
2020
packages = find:
2121

2222
[options.extras_require]
23-
docs = sphinx_autodoc_typehints; sphinx_rtd_theme; m2r2
23+
docs = sphinx; sphinx_autodoc_typehints; sphinx_rtd_theme; myst-parser

0 commit comments

Comments
 (0)