Fix typos (#331)

pull/348/head
Kian-Meng Ang 2 years ago committed by GitHub
parent 432b9af5d5
commit 075736619f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -174,7 +174,7 @@ Bug Fixes
* `#244 <https://github.com/readthedocs/sphinx-autoapi/issues/244>`:
Fixed an unnecessary deprecation warning being raised when running
sphinx-build from the same directory as conf.py.
* (Python) Fixed properties documented by Autodoc directives geting documented as methods.
* (Python) Fixed properties documented by Autodoc directives getting documented as methods.
V1.5.1 (2020-10-01)
@ -506,7 +506,7 @@ Bug Fixes
* `#148 <https://github.com/readthedocs/sphinx-autoapi/issues/148>`: (Python) Fixed astroid 2.0 compatibility.
* (Python) Fixed filtered classes and attributes getting displayed.
* (Python) Fixed incorrect display of long lists.
* `#125 <https://github.com/readthedocs/sphinx-autoapi/issues/125>`: (Javacript) Fixed running incorrect jsdoc command on Windows.
* `#125 <https://github.com/readthedocs/sphinx-autoapi/issues/125>`: (Javascript) Fixed running incorrect jsdoc command on Windows.
* `#125 <https://github.com/readthedocs/sphinx-autoapi/issues/125>`: (Python) Support specifying package directories in ``autoapi_dirs``.
Trivial/Internal Changes

@ -34,7 +34,7 @@ class PythonMapperBase:
Required attributes:
:var str id: A globally unique indentifier for this object.
:var str id: A globally unique identifier for this object.
Generally a fully qualified name, including namespace.
:var str name: A short "display friendly" name for this object.
@ -121,7 +121,7 @@ class PythonMapperBase:
Slugs to a filename using the follow steps
* Decode unicode to approximate ascii
* Remove existing hypens
* Remove existing hyphens
* Substitute hyphens for non-word characters
* Break up the string as paths
"""

@ -359,7 +359,7 @@ class DotNetPythonMapper(PythonMapperBase):
Slugs to a filename using the follow steps
* Decode unicode to approximate ascii
* Remove existing hypens
* Remove existing hyphens
* Substitute hyphens for non-word characters
* Break up the string as paths
"""

@ -131,7 +131,7 @@ but we need to have a place to define the page structure in the HTML.
This can be done before or after the loading of the content into RST.
We decided to do it before loading into RST because that matches standard Sphinx convention.
Generally the markup being fed in as RST is considered to be in a file that maps to it's output loation.
If we tried to maniuplate this structure after loading into the Domain,
If we tried to manipulate this structure after loading into the Domain,
that could lead to unexpected consequences like wrong indexes and missing references.
File Structure vs. Hierarchy

@ -155,7 +155,7 @@ Customisation Options
Which docstring to insert into the content of a class.
* ``class``: Use only the class docstring.
* ``both``: Use the concatentation of the class docstring and the
* ``both``: Use the concatenation of the class docstring and the
``__init__`` docstring.
* ``init``: Use only the ``__init__`` docstring.

@ -3,6 +3,6 @@
This assumes that you have a ``docfx`` executable on your `PATH`.
It also depends on the sphinxcontrib-dotnet domain: https://github.com/readthedocs/sphinxcontrib-dotnetdomain
Currently this is setup to build the Indentity repo from ASP.Net
Currently this is setup to build the Identity repo from ASP.Net
You should simply be able to run ``make html`` in this directory.

@ -1 +1 @@
This is a fuction template override!
This is a function template override!

@ -104,7 +104,7 @@ class TestIntegration(LanguageIntegrationTests):
self._run_test(
"templateexample",
"_build/text/autoapi/example/index.txt",
"This is a fuction template override",
"This is a function template override",
)

Loading…
Cancel
Save