atlas-doc-parser

.. image:: https://readthedocs.org/projects/atlas-doc-parser/badge/?version=latest :target: https://atlas-doc-parser.readthedocs.io/en/latest/ :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/atlas_doc_parser-project/actions/workflows/main.yml/badge.svg :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/atlas_doc_parser-project/branch/main/graph/badge.svg :target: https://codecov.io/gh/MacHu-GWU/atlas_doc_parser-project

.. image:: https://img.shields.io/pypi/v/atlas-doc-parser.svg :target: https://pypi.python.org/pypi/atlas-doc-parser

.. image:: https://img.shields.io/pypi/l/atlas-doc-parser.svg :target: https://pypi.python.org/pypi/atlas-doc-parser

.. image:: https://img.shields.io/pypi/pyversions/atlas-doc-parser.svg :target: https://pypi.python.org/pypi/atlas-doc-parser

.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social :target: https://github.com/MacHu-GWU/atlas_doc_parser-project

.. image:: https://img.shields.io/badge/Link-Document-blue.svg :target: https://atlas-doc-parser.readthedocs.io/en/latest/

.. image:: https://img.shields.io/badge/Link-API-blue.svg :target: https://atlas-doc-parser.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg :target: install_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg :target: https://github.com/MacHu-GWU/atlas_doc_parser-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg :target: https://github.com/MacHu-GWU/atlas_doc_parser-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg :target: https://pypi.org/pypi/atlas-doc-parser#files

Welcome to atlas_doc_parser Documentation

.. image:: https://atlas-doc-parser.readthedocs.io/en/latest/_static/atlas_doc_parser-logo.png :target: https://atlas-doc-parser.readthedocs.io/en/latest/

A Python library for parsing Atlassian Document Format (ADF) - the rich text format used in Confluence pages and Jira issue fields. This library converts ADF JSON into Python objects and enables conversion to various documentation formats.

.. _install:

Install

atlas_doc_parser is released on PyPI, so all you need is to:

.. code-block:: console

$ pip install atlas-doc-parser

To upgrade to latest version:

.. code-block:: console

$ pip install --upgrade atlas-doc-parser