Skip to content

Commit 9885456

Browse files
committed
Revert to sphinx
1 parent 09fac74 commit 9885456

File tree

32 files changed

+407
-133
lines changed

32 files changed

+407
-133
lines changed

.readthedocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
version: 2
33

4-
mkdocs:
5-
configuration: "mkdocs.yml"
4+
sphinx:
5+
builder: "html"
6+
configuration: "docs/source/conf.py"
67
fail_on_warning: false
78

89
python:

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# DiffSync
2-
<!--intro start-->
2+
33
DiffSync is a utility library that can be used to compare and synchronize different datasets.
44

55
For example, it can be used to compare a list of devices from 2 inventory systems and, if required, synchronize them in either direction.
@@ -23,9 +23,9 @@ A.sync_to(B)
2323
```
2424

2525
You may wish to peruse the [`diffsync` GitHub topic](https://github.com/topics/diffsync) for examples of projects using this library.
26-
<!--intro end-->
26+
2727
# Getting started
28-
<!--getting started start-->
28+
2929
To be able to properly compare different datasets, DiffSync relies on a shared data model that both systems must use.
3030
Specifically, each system or dataset must provide a `DiffSync` "adapter" subclass, which in turn represents its dataset as instances of one or more `DiffSyncModel` data model classes.
3131

@@ -151,4 +151,3 @@ class BackendA(DiffSync):
151151
# The default DiffSync.sync_complete() method does nothing, but it's always a good habit to call super():
152152
super().sync_complete(source, diff, flags, logger)
153153
```
154-
<!--getting started end-->

diffsync/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class DiffSyncModel(BaseModel):
3737
This class has several underscore-prefixed class variables that subclasses should set as desired; see below.
3838
3939
NOTE: The groupings _identifiers, _attributes, and _children are mutually exclusive; any given field name can
40-
be included in **at most** one of these three tuples.
40+
be included in **at most** one of these three tuples.
4141
"""
4242

4343
_modelname: ClassVar[str] = "diffsyncmodel"

docs/api_reference/diff/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api_reference/diffsync.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/api_reference/diffsyncmodel.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/api_reference/enum/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api_reference/exceptions/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api_reference/helpers/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/api_reference/logging/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)