Skip to content

Commit 72e3cbe

Browse files
rafalkrupinskiRafał KrupińskiGitHub Action
authored
Fix docspec links in Readme. (#337)
* Fix docspec links in Readme. * Updated PR references in 1 changelogs. skip-checks: true --------- Co-authored-by: Rafał Krupiński <zloto@fastmail.com> Co-authored-by: GitHub Action <github-action@users.noreply.github.com>
1 parent 3f20390 commit 72e3cbe

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

.changelog/_unreleased.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,10 @@ type = "fix"
2525
description = "Fix `escape_except_blockquotes` option for greater than 9 blockquotes in a docstring"
2626
author = "@jackgerrits"
2727
pr = "https://github.com/NiklasRosenstein/pydoc-markdown/pull/317"
28+
29+
[[entries]]
30+
id = "01971878-9eb9-72a3-9bfd-d972c111930f"
31+
type = "docs"
32+
description = "Fix links to docspec"
33+
author = "@rafalkrupinski"
34+
pr = "https://github.com/NiklasRosenstein/pydoc-markdown/pull/337"

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
> docstrings for your Python project with MkDocs, consider [mkdocstrings](https://mkdocstrings.github.io/) instead.
88
99
Pydoc-Markdown is a tool to create Python API documentation in Markdown format. Instead of executing your Python
10-
code like so many other documentation tools, it parses it using [docspec][] instead.
10+
code like so many other documentation tools, it parses it using [docspec][https://niklasrosenstein.github.io/python-docspec/] instead.
1111

1212
[→ Go to the Documentation 📘][Documentation]
1313

1414
[contrib]: https://github.com/NiklasRosenstein/pydoc-markdown/blob/develop/.github/CONTRIBUTING.md
15-
[docspec]: https://niklasrosenstein.github.io/docspec/
15+
[docspec]: https://niklasrosenstein.github.io/python-docspec/
1616
[Documentation]: https://niklasrosenstein.github.io/pydoc-markdown/
1717
[MkDocs]: https://www.mkdocs.org/
1818
[Novella]: https://niklasrosenstein.github.io/novella/
@@ -47,7 +47,7 @@ generate documentation for is irrelevant.
4747

4848
* Understands multiple documentation styles (Sphinx, Google, Pydoc-Markdown specific) and converts them to properly
4949
formatted Markdown
50-
* Can parse docstrings for variables thanks to [docspec][] (`#:` block before or string literal after the statement)
50+
* Can parse docstrings for variables thanks to [docspec](https://niklasrosenstein.github.io/python-docspec/) (`#:` block before or string literal after the statement)
5151
* Generates links to other API objects per the documentation syntax (e.g. `#OtherClass` for the Pydoc-Markdown style)
5252
* Configure the output using a YAML file or `pyProject.toml`, then you're only one command away to generate the
5353
documentation in Markdown format

0 commit comments

Comments
 (0)