Skip to content

CDRIVER-5565 remove non-API docs #1600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 31 commits into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
230e59a
libmongoc: remove links to content moved to mongodb.com
kevinAlbs May 15, 2024
8568590
libmongoc: remove no-longer-referenced files
kevinAlbs May 15, 2024
5f8d88e
libmongoc: remove `genindex`
kevinAlbs May 15, 2024
a30ff7e
libmongoc: link to `MongoDB C Driver` page
kevinAlbs May 15, 2024
3053dd0
libmongoc: fix links to `queryable-encryption`
kevinAlbs May 15, 2024
65b95e6
libmongoc: fix links to `authentication`
kevinAlbs May 15, 2024
7cd99bb
libmongoc: fix links to `bulk`
kevinAlbs May 15, 2024
7e79a91
libmongoc: fix links to `client-side-field-level-encryption`
kevinAlbs May 15, 2024
255fd6c
libmongoc: fix links to `configuring_tls`
kevinAlbs May 15, 2024
2dad845
libmongoc: fix links to `connection-pooling`
kevinAlbs May 15, 2024
72cb134
libmongoc: fix links to `in-use-encryption`
kevinAlbs May 15, 2024
1270bfb
libmongoc: fix links to `manage-collection-indexes`
kevinAlbs May 15, 2024
d649883
libmongoc: fix links to ``setting_collation_order`
kevinAlbs May 15, 2024
21bae25
libmongoc: fix links to `tutorial_crud_operations`
kevinAlbs May 15, 2024
b3ee0fb
libmongoc: fix link to `bulk_operation_bypassing_document_validation`
kevinAlbs May 15, 2024
dd89629
libmongoc: fix links to `cursors_tailable`
kevinAlbs May 15, 2024
55f1ee1
libbson: remove links to content moved to mongodb.com
kevinAlbs May 15, 2024
566cc0c
libbson: link to `MongoDB C Driver` page
kevinAlbs May 15, 2024
ea4b360
libbson: remove no-longer-referenced files
kevinAlbs May 15, 2024
854ad7f
libbson: fix links to `errors`
kevinAlbs May 15, 2024
c9ab60e
libmongoc: fix links to `bson:errors`
kevinAlbs May 15, 2024
24c519a
libmongoc: fix links to `bson:lifetimes`
kevinAlbs May 15, 2024
32dbee3
homepage: link to `MongoDB C Driver` page
kevinAlbs May 15, 2024
be9cd6b
libmongoc: remove no-longer-used images
kevinAlbs May 15, 2024
6e31bde
libmongoc: remove unreferenced include
kevinAlbs May 15, 2024
7966ee7
update links in README
kevinAlbs May 15, 2024
b572054
update link in CONTRIBUTING.md
kevinAlbs May 15, 2024
269d51c
fix links to community forums
kevinAlbs May 15, 2024
747d260
add missing "the"
kevinAlbs May 16, 2024
8aa73f9
fix `setting_collation_order_` links
kevinAlbs May 16, 2024
932c1d8
fix `setting_collation_order_` in `generate-opts.py`
kevinAlbs May 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The mongo-c-driver has a few guidelines that help direct the process.
### Portability

mongo-c-driver is portable software. It needs to run on a multitude of
[Supported Platforms](https://mongoc.org/libmongoc/current/installing.html#supported-platforms).
[Supported Platforms](https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/ref/platforms/).


### Licensing
Expand Down
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ information:

Can you tell me what I need to install? Thanks!

.. _MongoDB Community Forums: https://community.mongodb.com/tags/c/drivers-odms-connectors/7/c-driver
.. _MongoDB Community Forums: https://www.mongodb.com/community/forums/tags/c/data/drivers/7/c-driver

Security Vulnerabilities
------------------------
Expand All @@ -87,12 +87,12 @@ Installation
============

Detailed installation instructions are in the manual:
https://www.mongoc.org/libmongoc/current/installing.html
https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/tutorials/obtaining-libraries/


Resources
============

* `Getting Started Tutorial <https://mongoc.org/libmongoc/current/tutorial.html>`_.
* `Getting Started Tutorial <https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/tutorial>`_.
* `MongoDB C Driver Examples <https://github.com/mongodb/mongo-c-driver/tree/master/src/libmongoc/examples>`_.
* Tutorials, videos, and code examples using the MongoDB C Driver can also be found in the `MongoDB Developer Center <https://www.mongodb.com/developer/languages/c/>`_.
* Tutorials, videos, and code examples using the MongoDB C Driver can also be found in the `MongoDB Developer Center <https://www.mongodb.com/developer/languages/c/>`_.
2 changes: 1 addition & 1 deletion build/generate-opts.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ def __init__(self, items, **defaults):

collation_option = ('collation', {
'type': 'document',
'help': 'Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.'
'help': 'Configure textual comparisons. See `Setting Collation Order <setting_collation_order_>`_, and `the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.'
})

array_filters_option = ('arrayFilters', {
Expand Down
5 changes: 5 additions & 0 deletions build/sphinx/homepage-config/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ def setup(app):
html_use_smartypants = False
html_show_sourcelink = False
html_use_index = False
rst_prolog = rf"""

.. _mongodb_docs_cdriver: https://www.mongodb.com/docs/languages/c/c-driver/current/

"""

html_sidebars = {
'**': []
Expand Down
16 changes: 8 additions & 8 deletions build/sphinx/homepage-config/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
MongoDB C Driver
================
MongoDB C Driver - API
======================

**A Cross Platform MongoDB Client Library for C**

The MongoDB C Driver, also known as "libmongoc", is a library for using MongoDB from C applications, and for writing MongoDB drivers in higher-level languages.

It depends on `libbson <libbson/current/index.html>`_ to generate and parse BSON documents, the native data format of MongoDB.

This site documents the API. For tutorials, guides, and explainers, see `MongoDB C Driver <mongodb_docs_cdriver_>`_.

Download
--------

Expand All @@ -15,18 +17,16 @@ Latest release: :download-link:`mongoc`
Documentation
-------------

`Installation <libmongoc/current/installing.html>`_

`Tutorial <libmongoc/current/tutorial.html>`_
For tutorials, guides, and explainers, see `MongoDB C Driver <mongodb_docs_cdriver_>`_.

`libmongoc reference <libmongoc/current/index.html>`_
- `libmongoc API documentation <libmongoc/current/index.html>`_

`libbson reference <libbson/current/index.html>`_
- `libbson API documentation <libbson/current/index.html>`_

How To Ask For Help
-------------------

For help using the driver: `MongoDB Community Forums <https://community.mongodb.com/tags/c/drivers-odms-connectors/7/c-driver>`_.
For help using the driver: `MongoDB Community Forums <https://www.mongodb.com/community/forums/tags/c/data/drivers/7/c-driver>`_.

To file a bug or feature request: `MongoDB Jira Issue Tracker <https://jira.mongodb.org/browse/CDRIVER>`_.

Expand Down
2 changes: 1 addition & 1 deletion src/libbson/doc/bson_error_t.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Description

The :symbol:`bson_error_t` structure is used as an out-parameter to pass error information to the caller. It should be stack-allocated and does not requiring freeing.

See :doc:`Handling Errors <errors>`.
See `Handling Errors <errors_>`_.

.. only:: html

Expand Down
8 changes: 8 additions & 0 deletions src/libbson/doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@

html_use_index = False

rst_prolog = rf"""

.. _mongodb_docs_cdriver: https://www.mongodb.com/docs/languages/c/c-driver/current/

.. _errors: https://www.mongodb.com/docs/languages/c/c-driver/current/libbson/tutorials/errors/

"""


def add_canonical_link(app, pagename, templatename, context, doctree):
link = f'<link rel="canonical" href="https://www.mongoc.org/libbson/current/{pagename}"/>'
Expand Down
101 changes: 0 additions & 101 deletions src/libbson/doc/creating.rst

This file was deleted.

10 changes: 0 additions & 10 deletions src/libbson/doc/cross-platform-notes.rst

This file was deleted.

7 changes: 0 additions & 7 deletions src/libbson/doc/endianness.rst

This file was deleted.

23 changes: 0 additions & 23 deletions src/libbson/doc/errors.rst

This file was deleted.

11 changes: 0 additions & 11 deletions src/libbson/doc/guides.rst

This file was deleted.

46 changes: 0 additions & 46 deletions src/libbson/doc/include-and-link.rst

This file was deleted.

20 changes: 4 additions & 16 deletions src/libbson/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,15 @@
libbson
=======
libbson - API
=============

A Cross Platform BSON Library for C

This site documents the API. For tutorials, guides, and explainers, see `MongoDB C Driver <mongodb_docs_cdriver_>`_.

Introduction
------------

libbson builds, parses, and iterates `BSON <http://bsonspec.org>`_ documents, the native data format of MongoDB. It also converts BSON to and from JSON, and provides a platform compatibility layer for `the MongoDB C Driver <https://www.mongoc.org/>`_.

.. toctree::
:titlesonly:

tutorial

.. toctree::
:titlesonly:

guides

.. toctree::
:titlesonly:

cross-platform-notes

.. toctree::
:titlesonly:
Expand Down
Loading