DevKit updates (sonata-project#627)

WebDaMa · Aug 11, 2021 · 4de6a2a · 4de6a2a
1 parent 4008f8b
commit 4de6a2a
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 165 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -6,6 +6,7 @@
 *.md export-ignore
 tests export-ignore
 docs export-ignore
+.readthedocs.yaml export-ignore
 Makefile export-ignore
 phpunit.xml.dist export-ignore
 phpstan.neon.dist export-ignore

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,10 @@
+version: 2
+
+sphinx:
+    builder: dirhtml
+    configuration: docs/conf.py
+
+python:
+    version: '3.7'
+    install:
+        - requirements: docs/requirements.txt
diff --git a/Makefile b/Makefile
@@ -85,7 +85,7 @@ endif
 .PHONY: test
 
 docs:
-	cd docs && sphinx-build -W -b html -d _build/doctrees . _build/html
+	cd docs && sphinx-build -W -b dirhtml -d _build/doctrees . _build/html
 .PHONY: docs
 
 phpstan:

diff --git a/README.md b/README.md
@@ -17,14 +17,14 @@ Symfony Sonata / Integrate Doctrine MongoDB ODM into the SonataAdminBundle
 [![Monthly Downloads](https://poser.pugx.org/sonata-project/doctrine-mongodb-admin-bundle/d/monthly)](https://packagist.org/packages/sonata-project/doctrine-mongodb-admin-bundle)
 [![Daily Downloads](https://poser.pugx.org/sonata-project/doctrine-mongodb-admin-bundle/d/daily)](https://packagist.org/packages/sonata-project/doctrine-mongodb-admin-bundle)
 
-Branch | Github Actions | Code Coverage |
------- | -------------- | ------------- |
-3.x    | [![Test][test_stable_badge]][test_stable_link]     | [![Coverage Status][coverage_stable_badge]][coverage_stable_link]     |
-master | [![Test][test_unstable_badge]][test_unstable_link] | [![Coverage Status][coverage_unstable_badge]][coverage_unstable_link] |
+Branch | Github Actions | Code Coverage | Documentation |
+------ | -------------- | ------------- | ------------- |
+3.x    | [![Test][test_stable_badge]][test_stable_link]     | [![Coverage Status][coverage_stable_badge]][coverage_stable_link]     | [![Documentation Status][documentation_stable_badge]][documentation_stable_link]     |
+master | [![Test][test_unstable_badge]][test_unstable_link] | [![Coverage Status][coverage_unstable_badge]][coverage_unstable_link] | [![Documentation Status][documentation_unstable_badge]][documentation_unstable_link] |
 
 ## Documentation
 
-Check out the documentation on the [official website](https://sonata-project.org/bundles/doctrine-mongodb-admin).
+Check out the documentation on the [official website](https://docs.sonata-project.org/projects/SonataDoctrineMongoDBAdminBundle).
 
 ## Support
 
@@ -48,3 +48,8 @@ This package is available under the [MIT license](LICENSE).
 [coverage_unstable_link]: https://codecov.io/gh/sonata-project/SonataDoctrineMongoDBAdminBundle/branch/master
 [shepherd_stable_badge]: https://shepherd.dev/github/sonata-project/SonataDoctrineMongoDBAdminBundle/coverage.svg
 [shepherd_stable_link]: https://shepherd.dev/github/sonata-project/SonataDoctrineMongoDBAdminBundle
+
+[documentation_stable_badge]: https://readthedocs.org/projects/sonatadoctrinemongodbadminbundle/badge/?version=3.x
+[documentation_stable_link]: https://docs.sonata-project.org/projects/SonataDoctrineMongoDBAdminBundle/en/3.x/?badge=3.x
+[documentation_unstable_badge]: https://readthedocs.org/projects/sonatadoctrinemongodbadminbundle/badge/?version=master
+[documentation_unstable_link]: https://docs.readthedocs.org/projects/SonataDoctrineMongoDBAdminBundle/en/master/?badge=master
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,11 +29,13 @@
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+needs_sphinx = '1.8.5'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sensio.sphinx.configurationblock', 'sensio.sphinx.phpcode']
+extensions = [
+    'sensio.sphinx.codeblock', 'sensio.sphinx.configurationblock', 'sensio.sphinx.phpcode'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -49,7 +51,7 @@
 
 # General information about the project.
 project = u'SonataDoctrineMongodbAdminBundle'
-copyright = u'2010-2020, Thomas Rabaix'
+copyright = u'2010-2021, Thomas Rabaix'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -102,7 +104,9 @@
 # enable highlighting for PHP code not between ``<?php ... ?>`` by default
 lexers['php'] = PhpLexer(startinline=True)
 lexers['php-annotations'] = PhpLexer(startinline=True)
+lexers['php-attributes'] = PhpLexer(startinline=True)
 lexers['php-standalone'] = PhpLexer(startinline=True)
+lexers['php-symfony'] = PhpLexer(startinline=True)
 
 # -- Options for HTML output ---------------------------------------------------
 import sphinx_rtd_theme

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,6 +2,7 @@
 #
 # It's auto-generated by sonata-project/dev-kit package.
 
-Sphinx==1.8.5
-git+https://github.com/fabpot/sphinx-php.git
-sphinx_rtd_theme
+Pygments==2.2.0
+sphinx==1.8.5
+git+https://github.com/fabpot/[email protected]#egg_name=sphinx-php
+sphinx_rtd_theme==0.5.2