NotificationsYou must be signed in to change notification settings
Fork37
Star150

Commitaca77bf

committed

Some documentation improvements and refactoring

1 parent8bac32e commitaca77bfCopy full SHA for aca77bf

File tree

4 files changed

+42

-37

lines changed

docs
- README.md
- source

4 files changed

+42

-37

lines changed

`‎docs/README.md‎`

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,15 @@`
	`1`	`+#Building the documentation`
	`2`	`+`
	`3`	+Make sure you have`Sphinx` and`sphinxcontrib-napoleon` packages installed:
	`4`	`+`
	`5`	+```
	`6`	`+pip install Sphinx sphinxcontrib-napoleon`
	`7`	+```
	`8`	`+`
	`9`	`+Then just run`
	`10`	`+`
	`11`	+```
	`12`	`+make html`
	`13`	+```
	`14`	`+`
	`15`	+Documentation will be built in`build/html` directory. Other output formats are also available; run`make` without arguments to see the options.

`‎docs/source/index.rst‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`Testgres documentation`
`3`	`3`	`======================`
`4`	`4`
`5`		`-Testgres is a PostgreSQL testingutility`
	`5`	`+Testgres is a PostgreSQL testingframework.`
`6`	`6`
`7`	`7`	`Installation`
`8`	`8`	`============`

`‎docs/source/modules.rst‎`

Lines changed: 0 additions & 7 deletions

This file was deleted.

`‎docs/source/testgres.rst‎`

Lines changed: 26 additions & 29 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,107 +1,104 @@`
`1`	`1`	`testgres package`
`2`	`2`	`================`
`3`	`3`
`4`		`-Submodules`
`5`		`-----------`
`6`		`-`
`7`		`-testgres.api module`
`8`		`--------------------`
	`4`	`+testgres.api`
	`5`	`+------------`
`9`	`6`
`10`	`7`	`..automodule::testgres.api`
`11`	`8`	`:members:`
`12`	`9`	`:undoc-members:`
`13`	`10`	`:show-inheritance:`
`14`	`11`
`15`		`-testgres.backup module`
`16`		`-----------------------`
	`12`	`+testgres.backup`
	`13`	`+---------------`
`17`	`14`
`18`	`15`	`..automodule::testgres.backup`
`19`	`16`	`:members:`
`20`	`17`	`:undoc-members:`
`21`	`18`	`:show-inheritance:`
`22`	`19`
`23`		`-testgres.cache module`
`24`		`----------------------`
	`20`	`+testgres.cache`
	`21`	`+--------------`
`25`	`22`
`26`	`23`	`..automodule::testgres.cache`
`27`	`24`	`:members:`
`28`	`25`	`:undoc-members:`
`29`	`26`	`:show-inheritance:`
`30`	`27`
`31`		`-testgres.config module`
`32`		`-----------------------`
	`28`	`+testgres.config`
	`29`	`+---------------`
`33`	`30`
`34`	`31`	`..automodule::testgres.config`
`35`	`32`	`:members:`
`36`	`33`	`:undoc-members:`
`37`	`34`	`:show-inheritance:`
`38`	`35`
`39`		`-testgres.connection module`
`40`		`---------------------------`
	`36`	`+testgres.connection`
	`37`	`+-------------------`
`41`	`38`
`42`	`39`	`..automodule::testgres.connection`
`43`	`40`	`:members:`
`44`	`41`	`:undoc-members:`
`45`	`42`	`:show-inheritance:`
`46`	`43`
`47`		`-testgres.consts module`
`48`		`-----------------------`
	`44`	`+testgres.consts`
	`45`	`+---------------`
`49`	`46`
`50`	`47`	`..automodule::testgres.consts`
`51`	`48`	`:members:`
`52`	`49`	`:undoc-members:`
`53`	`50`	`:show-inheritance:`
`54`	`51`
`55`		`-testgres.decorators module`
`56`		`---------------------------`
	`52`	`+testgres.decorators`
	`53`	`+-------------------`
`57`	`54`
`58`	`55`	`..automodule::testgres.decorators`
`59`	`56`	`:members:`
`60`	`57`	`:undoc-members:`
`61`	`58`	`:show-inheritance:`
`62`	`59`
`63`		`-testgres.defaults module`
`64`		`-------------------------`
	`60`	`+testgres.defaults`
	`61`	`+-----------------`
`65`	`62`
`66`	`63`	`..automodule::testgres.defaults`
`67`	`64`	`:members:`
`68`	`65`	`:undoc-members:`
`69`	`66`	`:show-inheritance:`
`70`	`67`
`71`		`-testgres.enums module`
`72`		`----------------------`
	`68`	`+testgres.enums`
	`69`	`+--------------`
`73`	`70`
`74`	`71`	`..automodule::testgres.enums`
`75`	`72`	`:members:`
`76`	`73`	`:undoc-members:`
`77`	`74`	`:show-inheritance:`
`78`	`75`
`79`		`-testgres.exceptions module`
`80`		`---------------------------`
	`76`	`+testgres.exceptions`
	`77`	`+-------------------`
`81`	`78`
`82`	`79`	`..automodule::testgres.exceptions`
`83`	`80`	`:members:`
`84`	`81`	`:undoc-members:`
`85`	`82`	`:show-inheritance:`
`86`	`83`
`87`		`-testgres.logger module`
`88`		`-----------------------`
	`84`	`+testgres.logger`
	`85`	`+---------------`
`89`	`86`
`90`	`87`	`..automodule::testgres.logger`
`91`	`88`	`:members:`
`92`	`89`	`:undoc-members:`
`93`	`90`	`:show-inheritance:`
`94`	`91`
`95`		`-testgres.node module`
`96`		`---------------------`
	`92`	`+testgres.node`
	`93`	`+-------------`
`97`	`94`
`98`	`95`	`..automodule::testgres.node`
`99`	`96`	`:members:`
`100`	`97`	`:undoc-members:`
`101`	`98`	`:show-inheritance:`
`102`	`99`
`103`		`-testgres.utils module`
`104`		`----------------------`
	`100`	`+testgres.utils`
	`101`	`+--------------`
`105`	`102`
`106`	`103`	`..automodule::testgres.utils`
`107`	`104`	`:members:`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commitaca77bf

File tree

4 files changed

4 files changed

`‎docs/README.md‎`

`‎docs/source/index.rst‎`

`‎docs/source/modules.rst‎`

`‎docs/source/testgres.rst‎`

0 commit comments