diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..97581ca --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +python: + install: + - requirements: requirements.txt + +sphinx: + configuration: conf.py + fail_on_warning: false \ No newline at end of file diff --git a/Behavioral/ChainOfResponsibilities/README.rst b/Behavioral/ChainOfResponsibilities/README.rst index 1bc4d88..ae66771 100644 --- a/Behavioral/ChainOfResponsibilities/README.rst +++ b/Behavioral/ChainOfResponsibilities/README.rst @@ -56,5 +56,5 @@ Tests/ChainTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/ChainOfResponsibilities +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/ChainOfResponsibilities .. __: http://en.wikipedia.org/wiki/Chain_of_responsibility_pattern \ No newline at end of file diff --git a/Behavioral/Command/README.rst b/Behavioral/Command/README.rst index 7517160..ae64def 100644 --- a/Behavioral/Command/README.rst +++ b/Behavioral/Command/README.rst @@ -89,5 +89,5 @@ Tests/UndoableCommandTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Command +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Command .. __: http://en.wikipedia.org/wiki/Command_pattern diff --git a/Behavioral/Interpreter/README.rst b/Behavioral/Interpreter/README.rst index 30d1418..ed19313 100644 --- a/Behavioral/Interpreter/README.rst +++ b/Behavioral/Interpreter/README.rst @@ -67,5 +67,5 @@ Tests/InterpreterTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Interpreter +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Interpreter .. __: https://en.wikipedia.org/wiki/Interpreter_pattern diff --git a/Behavioral/Iterator/README.rst b/Behavioral/Iterator/README.rst index a46d222..1207ea8 100644 --- a/Behavioral/Iterator/README.rst +++ b/Behavioral/Iterator/README.rst @@ -53,5 +53,5 @@ Tests/IteratorTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Iterator +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Iterator .. __: http://en.wikipedia.org/wiki/Iterator_pattern diff --git a/Behavioral/Mediator/README.rst b/Behavioral/Mediator/README.rst index 4bd6a18..4529fd7 100644 --- a/Behavioral/Mediator/README.rst +++ b/Behavioral/Mediator/README.rst @@ -63,5 +63,5 @@ Tests/MediatorTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Mediator +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Mediator .. __: http://en.wikipedia.org/wiki/Mediator_pattern diff --git a/Behavioral/Memento/README.rst b/Behavioral/Memento/README.rst index aad433d..fc4591f 100644 --- a/Behavioral/Memento/README.rst +++ b/Behavioral/Memento/README.rst @@ -81,5 +81,5 @@ Tests/MementoTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Memento +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Memento .. __: http://en.wikipedia.org/wiki/Memento_pattern diff --git a/Behavioral/NullObject/README.rst b/Behavioral/NullObject/README.rst index 37aade0..bb3cb80 100644 --- a/Behavioral/NullObject/README.rst +++ b/Behavioral/NullObject/README.rst @@ -70,5 +70,5 @@ Tests/LoggerTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/NullObject +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/NullObject .. __: http://en.wikipedia.org/wiki/Null_Object_pattern diff --git a/Behavioral/Observer/README.rst b/Behavioral/Observer/README.rst index 550bc08..d00fae2 100644 --- a/Behavioral/Observer/README.rst +++ b/Behavioral/Observer/README.rst @@ -54,5 +54,5 @@ Tests/ObserverTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Observer +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Observer .. __: http://en.wikipedia.org/wiki/Observer_pattern diff --git a/Behavioral/Specification/README.rst b/Behavioral/Specification/README.rst index 89c404d..b783597 100644 --- a/Behavioral/Specification/README.rst +++ b/Behavioral/Specification/README.rst @@ -71,5 +71,5 @@ Tests/SpecificationTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Specification +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Specification .. __: http://en.wikipedia.org/wiki/Specification_pattern diff --git a/Behavioral/State/README.rst b/Behavioral/State/README.rst index c252dd0..fb78606 100644 --- a/Behavioral/State/README.rst +++ b/Behavioral/State/README.rst @@ -60,5 +60,5 @@ Tests/StateTest.php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/State +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/State .. __: http://en.wikipedia.org/wiki/State_pattern \ No newline at end of file diff --git a/Behavioral/Strategy/README.rst b/Behavioral/Strategy/README.rst index fbc2140..e653922 100644 --- a/Behavioral/Strategy/README.rst +++ b/Behavioral/Strategy/README.rst @@ -67,5 +67,5 @@ Tests/StrategyTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Strategy +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Strategy .. __: http://en.wikipedia.org/wiki/Strategy_pattern \ No newline at end of file diff --git a/Behavioral/TemplateMethod/README.rst b/Behavioral/TemplateMethod/README.rst index bb768d6..23869b6 100644 --- a/Behavioral/TemplateMethod/README.rst +++ b/Behavioral/TemplateMethod/README.rst @@ -60,5 +60,5 @@ Tests/JourneyTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/TemplateMethod +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/TemplateMethod .. __: http://en.wikipedia.org/wiki/Template_method_pattern \ No newline at end of file diff --git a/Behavioral/Visitor/README.rst b/Behavioral/Visitor/README.rst index 53dd29c..8aa2131 100644 --- a/Behavioral/Visitor/README.rst +++ b/Behavioral/Visitor/README.rst @@ -64,5 +64,5 @@ Tests/VisitorTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Behavioral/Visitor +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Behavioral/Visitor .. __: http://en.wikipedia.org/wiki/Visitor_pattern diff --git a/Creational/AbstractFactory/README.rst b/Creational/AbstractFactory/README.rst index ee619b4..1456824 100644 --- a/Creational/AbstractFactory/README.rst +++ b/Creational/AbstractFactory/README.rst @@ -84,5 +84,5 @@ Tests/AbstractFactoryTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/AbstractFactory +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/AbstractFactory .. __: http://en.wikipedia.org/wiki/Abstract_factory_pattern diff --git a/Creational/Builder/README.rst b/Creational/Builder/README.rst index e4d3dbe..b833617 100644 --- a/Creational/Builder/README.rst +++ b/Creational/Builder/README.rst @@ -101,5 +101,5 @@ Tests/DirectorTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/Builder +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/Builder .. __: http://en.wikipedia.org/wiki/Builder_pattern diff --git a/Creational/FactoryMethod/README.rst b/Creational/FactoryMethod/README.rst index b30e33a..3912311 100644 --- a/Creational/FactoryMethod/README.rst +++ b/Creational/FactoryMethod/README.rst @@ -73,5 +73,5 @@ Tests/FactoryMethodTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/FactoryMethod +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/FactoryMethod .. __: http://en.wikipedia.org/wiki/Factory_method_pattern diff --git a/Creational/Pool/README.rst b/Creational/Pool/README.rst index 560c51e..73bf17e 100644 --- a/Creational/Pool/README.rst +++ b/Creational/Pool/README.rst @@ -57,5 +57,5 @@ Tests/PoolTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/Pool +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/Pool .. __: http://en.wikipedia.org/wiki/Object_pool_pattern diff --git a/Creational/Prototype/README.rst b/Creational/Prototype/README.rst index d1c8e56..f038816 100644 --- a/Creational/Prototype/README.rst +++ b/Creational/Prototype/README.rst @@ -52,5 +52,5 @@ Tests/PrototypeTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/Prototype +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/Prototype .. __: http://en.wikipedia.org/wiki/Prototype_pattern diff --git a/Creational/SimpleFactory/README.rst b/Creational/SimpleFactory/README.rst index 3056c8c..ce66827 100644 --- a/Creational/SimpleFactory/README.rst +++ b/Creational/SimpleFactory/README.rst @@ -53,4 +53,4 @@ Tests/SimpleFactoryTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/SimpleFactory +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/SimpleFactory diff --git a/Creational/Singleton/README.rst b/Creational/Singleton/README.rst index 1e4fb1d..bd56557 100644 --- a/Creational/Singleton/README.rst +++ b/Creational/Singleton/README.rst @@ -47,5 +47,5 @@ Tests/SingletonTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/Singleton +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/Singleton .. __: http://en.wikipedia.org/wiki/Singleton_pattern diff --git a/Creational/StaticFactory/README.rst b/Creational/StaticFactory/README.rst index afcebcf..7c64735 100644 --- a/Creational/StaticFactory/README.rst +++ b/Creational/StaticFactory/README.rst @@ -55,4 +55,4 @@ Tests/StaticFactoryTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Creational/StaticFactory +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Creational/StaticFactory diff --git a/More/EAV/README.rst b/More/EAV/README.rst index 41adc20..3d26142 100644 --- a/More/EAV/README.rst +++ b/More/EAV/README.rst @@ -50,5 +50,5 @@ Tests/EAVTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/More/EAV +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/More/EAV .. __: https://en.wikipedia.org/wiki/Entity–attribute–value_model diff --git a/More/Repository/README.rst b/More/Repository/README.rst index 7432969..b1cc941 100644 --- a/More/Repository/README.rst +++ b/More/Repository/README.rst @@ -76,4 +76,4 @@ Tests/PostRepositoryTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/More/Repository +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/More/Repository diff --git a/More/ServiceLocator/README.rst b/More/ServiceLocator/README.rst index c1b98e8..3fb9946 100644 --- a/More/ServiceLocator/README.rst +++ b/More/ServiceLocator/README.rst @@ -60,5 +60,5 @@ Tests/ServiceLocatorTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/More/ServiceLocator +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/More/ServiceLocator .. __: http://en.wikipedia.org/wiki/Service_locator_pattern diff --git a/README.md b/README.md index ed2e68b..cca08fa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DesignPatternsPHP -[![Build Status](https://github.com/domnikl/DesignPatternsPHP/workflows/CI/badge.svg)](https://github.com/domnikl/DesignPatternsPHP/actions) +[![Build Status](https://github.com/DesignPatternsPHP/DesignPatternsPHP/workflows/CI/badge.svg)](https://github.com/DesignPatternsPHP/DesignPatternsPHP/actions) Note from the maintainers: > The project's ReadTheDocs pages is currently down and are being reconfigured. We're sorry for any inconvenience please read through the repository directly on github. diff --git a/Structural/Adapter/README.rst b/Structural/Adapter/README.rst index 5b7f3c6..7d9d438 100644 --- a/Structural/Adapter/README.rst +++ b/Structural/Adapter/README.rst @@ -67,5 +67,5 @@ Tests/AdapterTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Adapter +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Adapter .. __: http://en.wikipedia.org/wiki/Adapter_pattern diff --git a/Structural/Bridge/README.rst b/Structural/Bridge/README.rst index 7c433f2..f3854ce 100644 --- a/Structural/Bridge/README.rst +++ b/Structural/Bridge/README.rst @@ -64,5 +64,5 @@ Tests/BridgeTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Bridge +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Bridge .. __: http://en.wikipedia.org/wiki/Bridge_pattern diff --git a/Structural/Composite/README.rst b/Structural/Composite/README.rst index 79a6894..4c73df5 100644 --- a/Structural/Composite/README.rst +++ b/Structural/Composite/README.rst @@ -59,5 +59,5 @@ Tests/CompositeTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Composite +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Composite .. __: http://en.wikipedia.org/wiki/Composite_pattern diff --git a/Structural/DataMapper/README.rst b/Structural/DataMapper/README.rst index 3fb1a06..51bce85 100644 --- a/Structural/DataMapper/README.rst +++ b/Structural/DataMapper/README.rst @@ -62,5 +62,5 @@ Tests/DataMapperTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/DataMapper +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/DataMapper .. __: http://en.wikipedia.org/wiki/Data_mapper_pattern diff --git a/Structural/DataMapper/Tests/DataMapperTest.php b/Structural/DataMapper/Tests/DataMapperTest.php index 0f0ed50..c5ab58b 100644 --- a/Structural/DataMapper/Tests/DataMapperTest.php +++ b/Structural/DataMapper/Tests/DataMapperTest.php @@ -14,7 +14,7 @@ class DataMapperTest extends TestCase { public function testCanMapUserFromStorage() { - $storage = new StorageAdapter([1 => ['username' => 'domnikl', 'email' => 'liebler.dominik@gmail.com']]); + $storage = new StorageAdapter([1 => ['username' => 'someone', 'email' => 'someone@example.com']]); $mapper = new UserMapper($storage); $user = $mapper->findById(1); diff --git a/Structural/Decorator/README.rst b/Structural/Decorator/README.rst index 3c09f7e..bf2466d 100644 --- a/Structural/Decorator/README.rst +++ b/Structural/Decorator/README.rst @@ -63,5 +63,5 @@ Tests/DecoratorTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Decorator +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Decorator .. __: http://en.wikipedia.org/wiki/Decorator_pattern diff --git a/Structural/DependencyInjection/README.rst b/Structural/DependencyInjection/README.rst index 9bd212d..e1be43b 100644 --- a/Structural/DependencyInjection/README.rst +++ b/Structural/DependencyInjection/README.rst @@ -59,5 +59,5 @@ Tests/DependencyInjectionTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/DependencyInjection +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/DependencyInjection .. __: http://en.wikipedia.org/wiki/Dependency_injection diff --git a/Structural/DependencyInjection/Tests/DependencyInjectionTest.php b/Structural/DependencyInjection/Tests/DependencyInjectionTest.php index e9cc6c1..8402cf5 100644 --- a/Structural/DependencyInjection/Tests/DependencyInjectionTest.php +++ b/Structural/DependencyInjection/Tests/DependencyInjectionTest.php @@ -12,9 +12,9 @@ class DependencyInjectionTest extends TestCase { public function testDependencyInjection() { - $config = new DatabaseConfiguration('localhost', 3306, 'domnikl', '1234'); + $config = new DatabaseConfiguration('localhost', 3306, 'user', '1234'); $connection = new DatabaseConnection($config); - $this->assertSame('domnikl:1234@localhost:3306', $connection->getDsn()); + $this->assertSame('user:1234@localhost:3306', $connection->getDsn()); } } diff --git a/Structural/Facade/README.rst b/Structural/Facade/README.rst index 8e1cf25..52b99cc 100644 --- a/Structural/Facade/README.rst +++ b/Structural/Facade/README.rst @@ -62,5 +62,5 @@ Tests/FacadeTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Facade +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Facade .. __: http://en.wikipedia.org/wiki/Facade_pattern diff --git a/Structural/FluentInterface/README.rst b/Structural/FluentInterface/README.rst index 1025b32..6eb4b32 100644 --- a/Structural/FluentInterface/README.rst +++ b/Structural/FluentInterface/README.rst @@ -41,5 +41,5 @@ Tests/FluentInterfaceTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/FluentInterface +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/FluentInterface .. __: http://en.wikipedia.org/wiki/Fluent_interface \ No newline at end of file diff --git a/Structural/Flyweight/README.rst b/Structural/Flyweight/README.rst index d06ff2a..fce0ad0 100644 --- a/Structural/Flyweight/README.rst +++ b/Structural/Flyweight/README.rst @@ -53,5 +53,5 @@ Tests/FlyweightTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Flyweight +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Flyweight .. __: https://en.wikipedia.org/wiki/Flyweight_pattern diff --git a/Structural/Proxy/README.rst b/Structural/Proxy/README.rst index c7b56b9..2d3480b 100644 --- a/Structural/Proxy/README.rst +++ b/Structural/Proxy/README.rst @@ -52,5 +52,5 @@ ProxyTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Proxy +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Proxy .. __: http://en.wikipedia.org/wiki/Proxy_pattern diff --git a/Structural/Registry/README.rst b/Structural/Registry/README.rst index 96d1fff..ef97e12 100644 --- a/Structural/Registry/README.rst +++ b/Structural/Registry/README.rst @@ -42,5 +42,5 @@ Tests/RegistryTest.php :language: php :linenos: -.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/main/Structural/Registry +.. _`GitHub`: https://github.com/DesignPatternsPHP/DesignPatternsPHP/tree/main/Structural/Registry .. __: http://en.wikipedia.org/wiki/Service_locator_pattern diff --git a/composer.json b/composer.json index 4afb2c3..d3f102c 100644 --- a/composer.json +++ b/composer.json @@ -6,6 +6,10 @@ { "name": "Dominik Liebler", "email": "liebler.dominik@googlemail.com" + }, + { + "name": "Borislav Sabev", + "email": "39cn9aod@mailer.me" } ], "minimum-stability": "stable", diff --git a/conf.py b/conf.py index ecd5e29..ed2dd23 100644 --- a/conf.py +++ b/conf.py @@ -43,7 +43,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'README' +master_doc = 'index' # General information about the project. project = u'DesignPatternsPHP' @@ -64,7 +64,7 @@ release = '1.0' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/README.rst b/index.rst similarity index 77% rename from README.rst rename to index.rst index 6dcee83..17d9e53 100644 --- a/README.rst +++ b/index.rst @@ -8,18 +8,14 @@ DesignPatternsPHP ================= -.. image:: https://github.com/domnikl/DesignPatternsPHP/workflows/CI/badge.svg - :target: https://github.com/domnikl/DesignPatternsPHP/actions +.. image:: https://github.com/DesignPatternsPHP/DesignPatternsPHP/workflows/CI/badge.svg + :target: https://github.com/DesignPatternsPHP/DesignPatternsPHP/actions :alt: Build Status .. image:: https://readthedocs.org/projects/designpatternsphp/badge/?version=latest :target: https://readthedocs.org/projects/designpatternsphp/?badge=latest :alt: Documentation Status -.. image:: https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square - :target: https://paypal.me/DominikLiebler - :alt: Donate - This is a collection of known design patterns and some sample code how to implement them in PHP. Every pattern has a small list of examples. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..afc587c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinx_rtd_theme +readthedocs-sphinx-search \ No newline at end of file