Skip to content

Commit

Permalink
docs: rename api.adoc→lib.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
rezib committed Oct 25, 2023
1 parent e23a2d7 commit 252bcb1
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/modules/db/pages/concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ CAUTION: An object cannot be defined with more than one key property in the
xref:#schema[schema].

NOTE: This is particularly useful to facilitate selection of a particular object
among a list in the xref:usage:api.adoc[library API].
among a list in the xref:usage:lib.adoc[Python library].

NOTE: Keys are also involved in xref:#equivalence[sequence/mapping equivalence]
concept.
Expand Down Expand Up @@ -123,7 +123,7 @@ They are automatically defined and resolved by RacksDB when loading the
database.

NOTE: Back references are essentially used for convenience in the
xref:usage:api.adoc[library API].
xref:usage:lib.adoc[Python library].
--

[#deftype]
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/db/pages/ext.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ respect the structure defined by the combination of the vendor schema and the
defined extensions.

The additional data is automatically available through the
xref:usage:racksdb.adoc[CLI] and xref:usage:api.adoc[library API],
without further modification.
xref:usage:racksdb.adoc[CLI], xref:usage:lib.adoc[Python library] and
xref:usage:rest.adoc[REST API] without further modification.

This feature can be used to enrich RacksDB database with data useful to your
applications without requiring another data source, with the advantage of being
Expand All @@ -26,7 +26,7 @@ silently ignores it and just loads the built-in schema without modification.

NOTE: RacksDB can load extensions at the path of your choice, at the condition
of specifying this path in xref:usage:racksdb.adoc[`racksdb`
command] options and xref:usage:api.adoc[library `load()`] arguments. For this
command] options and xref:usage:lib.adoc[library `load()`] arguments. For this
reason, it is highly recommended to use the default path.

== Content
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/db/pages/files.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ By default, RacksDB expects the database to be located in

NOTE: RacksDB can load databases at the location of your choice, at the
condition of specifying the path in xref:usage:racksdb.adoc[`racksdb`
command] options and xref:usage:api.adoc[library `load()`] arguments. For this
command] options and xref:usage:lib.adoc[library `load()`] arguments. For this
reason, it is highly recommended to use the default path.

[#splitted]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/install/pages/quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ mercury (Mercury HPC cluster): ['hpc', 'cluster']
[sidebar]
--
.More links
* xref:usage:api.adoc[Python Library reference documentation]
* xref:usage:lib.adoc[Python Library reference documentation]
--

[#restapi]
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/overview/pages/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ image::overview:racksdb_interfaces.svg[RacksDB Interfaces,400]
Once the database is defined, data can be searched and extracted using the
xref:usage:racksdb.adoc[`racksdb` CLI].

For full integration with your software, a xref:usage:api.adoc[Python library
For full integration with your software, a xref:usage:lib.adoc[Python library
] and a xref:usage:rest.adoc[REST API] can also be used to stay continuously
synchronized with database content.

[sidebar]
--
.More links
* xref:usage:racksdb.adoc[`racksdb` command manual]
* xref:usage:api.adoc[Python Library reference] documentation with examples
* xref:usage:lib.adoc[Python Library reference] documentation with examples
* xref:usage:rest.adoc[REST API reference] documentation with examples
--

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/overview/pages/start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ Advanced detailed informations are available:
[no-bullet]
* icon:database[] xref:db:def.adoc[Database schema reference documentation]
* icon:terminal[] xref:usage:racksdb.adoc[`racksdb` command manpage]
* icon:code[] xref:usage:api.adoc[Python Library] and
* icon:code[] xref:usage:lib.adoc[Python Library] and
xref:usage:rest.adoc[REST API] reference documentations
* icon:maximize[] xref:db:ext.adoc[Schema extension howto]
2 changes: 1 addition & 1 deletion docs/modules/usage/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
* CLI manpages
** xref:racksdb.adoc[`racksdb`]
** xref:racksdb-web.adoc[`racksdb-web`]
* xref:api.adoc[]
* xref:lib.adoc[]
* xref:rest.adoc[]
File renamed without changes.

0 comments on commit 252bcb1

Please sign in to comment.