Metadata-Version: 2.1
Name: sphinxext-opengraph
Version: 0.1.2
Summary: Sphinx Extension to enable OGP support
Home-page: https://github.com/wpilibsuite/sphinxext-opengraph
Author: Itay Ziv
Author-email: itay220204@gmail.com
License: UNKNOWN
Description: # sphinxext-opengraph
        Sphinx extension to generate OpenGraph metadata (https://ogp.me/)
        
        ## Installation
        
        `python -m pip install sphinxext-opengraph`
        
        ## Options
        These values are placed in the conf.py of your sphinx project.
        
        * `ogp_site_url`
            * This config option is very important, set it to the URL the site is being hosted on. 
        * `ogp_description_length`
            * Configure the amount of characters taken from a page. The default of 200 is probably good for most people. If something other than a number is used, it defaults back to 200. 
        * `ogp_image`
            * This is not required. Link to image to show.
        * `ogp_type`
            * This sets the ogp type attribute, for more information on the types available please take a look at https://ogp.me/#types. By default it is set to `website`, which should be fine for most use cases.
        
        ## Example Config
        
        ### Simple Config
        
        ```python
        ogp_site_url = "http://example.org/"
        ogp_image = "http://example.org/image.png"
        ```
        
        ### Advanced Config
        
        ```python
        ogp_site_url = "http://example.org/"
        ogp_image = "http://example.org/image.png"
        ogp_description_length = 300
        ogp_type = "article"
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
