added docs as a subdirectory

This commit is contained in:
ronny abraham 2023-07-07 19:12:26 +03:00
parent ce52403b15
commit 69f644c763
3 changed files with 21 additions and 12 deletions

3
.gitmodules vendored Normal file
View file

@ -0,0 +1,3 @@
[submodule "docs"]
path = docs
url = git@bitbucket.org:ronnyabraham/fabric_docs.git

1
docs Submodule

@ -0,0 +1 @@
Subproject commit 697af1a3153808dbffd87c415b9619ea59788696

View file

@ -50,6 +50,10 @@ def generate_secret_key():
@task
def test(args=None):
"""
the purpose of this method is just to use as a placeholder for any kind of
testing of methods
"""
print("debug - testing checkapp(sorl.thumbnail): %s" %
check_app("sorl.thumbnail"))
@ -172,39 +176,40 @@ def coverage(application, args="test", workingdir=None, outputdir=None,
Helper method that uses the coverage package
:parameter application: the name of the installed application being tested.
NOTE: this is required because currently I do not know how to run manage.py
test on all installed applications.
NOTE: this is required because currently I do not know how to run
manage.py test on all installed applications.
:type application: string
:parameter args: the manage command that coverage is going to run.
defaults to test
defaults to test
:type args: string
:parameter workingdir: the working directory that manage will run it's
command under. defaults to None
command under. defaults to None
:type workingdir: string
:parameter outputdir: the directory to which file results will be
output to. defaults to None
output to. defaults to None
:type outputdir: string
:parameter coveragerc: flags whether or not there is a coverage settings
file which determines what coverage will or wont do. coveragerc file is
located in share/coverage/setup.cfg you can modify this in the virtualenv
settings for this branch. defaults to True
file which determines what coverage will or wont do. coveragerc file
is located in share/coverage/setup.cfg you can modify this in the
virtualenv settings for this branch. defaults to True
:type coveragerc: boolean
:parameter report: flags whether or not coverage will be asked to generate
a report. defaults to true.
a report. defaults to true.
:type report: boolean
:parameter html: flags whether or not coverage will generate an html
version of its report. defaults to true
version of its report. defaults to true
:type html: boolean
TODO: test if coverage is installed and if it isn't give
an error explaining the problem
TODO:
test if coverage is installed and if it isn't give an error explaining
the problem
TODO:
currently, django.manage:test is not working properly because it does