# HG changeset patch # User Damien Correia # Date 1522847973 -7200 # Node ID 55a05201f18c586bf6c031204b8c60dbb1f9a87f # Parent 475ba5e426669d5dd6868080024a6d29154885db Updated Doc, fix dependance warning diff -r 475ba5e42666 -r 55a05201f18c src/source/admin.rst --- a/src/source/admin.rst Wed Apr 04 10:33:01 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,11 +0,0 @@ -.. _admin: - - -Admin's Guide -================ - -.. toctree:: - :maxdepth: 2 - - Installation - Settings diff -r 475ba5e42666 -r 55a05201f18c src/source/appinstall.rst --- a/src/source/appinstall.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/appinstall.rst Wed Apr 04 15:19:33 2018 +0200 @@ -386,7 +386,18 @@ Serving on http://0.0.0.0:6543 -From this point, you can launch a browser and open URL *http://127.0.0.1:6543/admin* to get access to PyAMS -management interface; default login is "admin/admin", that you may change as soon as possible (see -:ref:`pyams_security`)!!. +Congrats: PyAMS is running ! + +Launch a browser and open URL http://127.0.0.1:6543/admin to get access to PyAMS management interface. + +.. warning:: + + By default: + - Login: admin + + - Password: admin + + **You must change it as soon as possible!** + (see :ref:`pyams_security`)!!. + diff -r 475ba5e42666 -r 55a05201f18c src/source/index.rst --- a/src/source/index.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/index.rst Wed Apr 04 15:19:33 2018 +0200 @@ -14,26 +14,29 @@ .. toctree:: :maxdepth: 2 - :caption: GETTING STARTED + :caption: Getting started Introduction + Application architecture Quickstart .. toctree:: :maxdepth: 2 - :caption: TUTORIAL + :caption: Tutorial User’s Guide + screenshots .. toctree:: :maxdepth: 2 - :caption: DEVELOPER DOCUMENTATION + :caption: Custom install documentation - Application architecture ZODB Server PyAMS Installation - Settings - API documentation + PyAMS Configuration + site + scripts + @@ -42,59 +45,14 @@ PyAMS is built on many external packages, and provides a whole set of extensions. Here is a list of them: -* pyams_template (:ref:`pyams_template`) - -* pyams_viewlet (:ref:`pyams_viewlet`) - -* pyams_pagelet (:ref:`pyams_pagelet`) - -* pyams_utils (:ref:`pyams_utils`) - -* pyams_skin (:ref:`pyams_skin`) - -* pyams_form (:ref:`pyams_form`) - -* pyams_file (:ref:`pyams_file`) - -* pyams_i18n (:ref:`pyams_i18n`) - -* pyams_security (:ref:`pyams_security`) - -* pyams_zmi (:ref:`pyams_zmi`) - -* pyams_zodbbrowser (:ref:`pyams_zodbbrowser`) - -* pyams_catalog (:ref:`pyams_catalog`) - -* pyams_mail (:ref:`pyams_mail`) -* pyams_ldap (:ref:`pyams_ldap`) - -* pyams_cache (:ref:`pyams_cache`) - -* pyams_alchemy (:ref:`pyams_alchemy`) - -* pyams_zmq (:ref:`pyams_zmq`) - -* pyams_scheduler (:ref:`pyams_scheduler`) - -* pyams_workflow (:ref:`pyams_workflow`) - -* pyams_thesaurus (:ref:`pyams_thesaurus`) +.. toctree:: + :maxdepth: 2 + :caption: API documentation -* pyams_sequence (:ref:`pyams_sequence`) - -* pyams_portal (:ref:`pyams_portal`) - -* pyams_media (:ref:`pyams_media`) + extend + modules -* pyams_notify (:ref:`pyams_notify`) - -* pyams_gis (:ref:`pyams_gis`) - -* pyams_content (:ref:`pyams_content`) - -* pyams_content_es (:ref:`pyams_content_es`) Indices and tables diff -r 475ba5e42666 -r 55a05201f18c src/source/modules.rst --- a/src/source/modules.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/modules.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,35 +1,35 @@ .. _modules: -Modules list -============ +PyAMS modules +============= .. toctree:: :maxdepth: 1 - pyams_template - pyams_viewlet - pyams_pagelet - pyams_utils - pyams_skin - pyams_form - pyams_file - pyams_i18n - pyams_security - pyams_zmi - pyams_zodbbrowser - pyams_catalog - pyams_mail - pyams_ldap - pyams_cache - pyams_alchemy - pyams_zmq - pyams_scheduler - pyams_workflow - pyams_thesaurus - pyams_sequence - pyams_portal - pyams_media - pyams_notify - pyams_gis - pyams_content - pyams_content_es + Alchemy + Cache + Catalog + Content + Content_es + File + Form + GIS + I18N + LDAP + Mail + Media + Notify + Pagelet + Portal + Scheduler + Security + Sequence + Skin + Template + Thesaurus + Utils + Viewlet + Workflow + ZMI + ZMQ + ZODBbrowser diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content/pyams_content.rst --- a/src/source/pyams_content/pyams_content.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_content/pyams_content.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_content: + pyams\_content package ====================== diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content/pyams_content_es.component.rst --- a/src/source/pyams_content/pyams_content_es.component.rst Wed Apr 04 10:33:01 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,62 +0,0 @@ -pyams\_content\_es\.component package -===================================== - -Submodules ----------- - -pyams\_content\_es\.component\.extfile module ---------------------------------------------- - -.. automodule:: pyams_content_es.component.extfile - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.component\.gallery module ---------------------------------------------- - -.. automodule:: pyams_content_es.component.gallery - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.component\.paragraph module ------------------------------------------------ - -.. automodule:: pyams_content_es.component.paragraph - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.component\.theme module -------------------------------------------- - -.. automodule:: pyams_content_es.component.theme - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.component\.view module ------------------------------------------- - -.. automodule:: pyams_content_es.component.view - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.component\.workflow module ----------------------------------------------- - -.. automodule:: pyams_content_es.component.workflow - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content_es.component - :members: - :undoc-members: - :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content/pyams_content_es.interfaces.rst --- a/src/source/pyams_content/pyams_content_es.interfaces.rst Wed Apr 04 10:33:01 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ -pyams\_content\_es\.interfaces package -====================================== - -Module contents ---------------- - -.. automodule:: pyams_content_es.interfaces - :members: - :undoc-members: - :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content/pyams_content_es.rst --- a/src/source/pyams_content/pyams_content_es.rst Wed Apr 04 10:33:01 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,73 +0,0 @@ -pyams\_content\_es package -========================== - -Subpackages ------------ - -.. toctree:: - - pyams_content_es.component - pyams_content_es.interfaces - pyams_content_es.scripts - pyams_content_es.tests - pyams_content_es.zmi - -Submodules ----------- - -pyams\_content\_es\.document module ------------------------------------ - -.. automodule:: pyams_content_es.document - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.include module ----------------------------------- - -.. automodule:: pyams_content_es.include - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.index module --------------------------------- - -.. automodule:: pyams_content_es.index - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.process module ----------------------------------- - -.. automodule:: pyams_content_es.process - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.site module -------------------------------- - -.. automodule:: pyams_content_es.site - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.utility module ----------------------------------- - -.. automodule:: pyams_content_es.utility - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content_es - :members: - :undoc-members: - :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content/pyams_content_es.scripts.rst --- a/src/source/pyams_content/pyams_content_es.scripts.rst Wed Apr 04 10:33:01 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_content\_es\.scripts package -=================================== - -Submodules ----------- - -pyams\_content\_es\.scripts\.index module ------------------------------------------ - -.. automodule:: pyams_content_es.scripts.index - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content_es.scripts - :members: - :undoc-members: - :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content/pyams_content_es.tests.rst --- a/src/source/pyams_content/pyams_content_es.tests.rst Wed Apr 04 10:33:01 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -pyams\_content\_es\.tests package -================================= - -Submodules ----------- - -pyams\_content\_es\.tests\.test\_utilsdocs module -------------------------------------------------- - -.. automodule:: pyams_content_es.tests.test_utilsdocs - :members: - :undoc-members: - :show-inheritance: - -pyams\_content\_es\.tests\.test\_utilsdocstrings module -------------------------------------------------------- - -.. automodule:: pyams_content_es.tests.test_utilsdocstrings - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content_es.tests - :members: - :undoc-members: - :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content/pyams_content_es.zmi.rst --- a/src/source/pyams_content/pyams_content_es.zmi.rst Wed Apr 04 10:33:01 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -pyams\_content\_es\.zmi package -=============================== - -Submodules ----------- - -pyams\_content\_es\.zmi\.test module ------------------------------------- - -.. automodule:: pyams_content_es.zmi.test - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: pyams_content_es.zmi - :members: - :undoc-members: - :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content_es/pyams_content_es.component.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_content_es/pyams_content_es.component.rst Wed Apr 04 15:19:33 2018 +0200 @@ -0,0 +1,62 @@ +pyams\_content\_es\.component package +===================================== + +Submodules +---------- + +pyams\_content\_es\.component\.extfile module +--------------------------------------------- + +.. automodule:: pyams_content_es.component.extfile + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.component\.gallery module +--------------------------------------------- + +.. automodule:: pyams_content_es.component.gallery + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.component\.paragraph module +----------------------------------------------- + +.. automodule:: pyams_content_es.component.paragraph + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.component\.theme module +------------------------------------------- + +.. automodule:: pyams_content_es.component.theme + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.component\.view module +------------------------------------------ + +.. automodule:: pyams_content_es.component.view + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.component\.workflow module +---------------------------------------------- + +.. automodule:: pyams_content_es.component.workflow + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_content_es.component + :members: + :undoc-members: + :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content_es/pyams_content_es.interfaces.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_content_es/pyams_content_es.interfaces.rst Wed Apr 04 15:19:33 2018 +0200 @@ -0,0 +1,10 @@ +pyams\_content\_es\.interfaces package +====================================== + +Module contents +--------------- + +.. automodule:: pyams_content_es.interfaces + :members: + :undoc-members: + :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content_es/pyams_content_es.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_content_es/pyams_content_es.rst Wed Apr 04 15:19:33 2018 +0200 @@ -0,0 +1,75 @@ +.. _pyams_content_es: + +pyams\_content\_es package +========================== + +Subpackages +----------- + +.. toctree:: + + pyams_content_es.component + pyams_content_es.interfaces + pyams_content_es.scripts + pyams_content_es.tests + pyams_content_es.zmi + +Submodules +---------- + +pyams\_content\_es\.document module +----------------------------------- + +.. automodule:: pyams_content_es.document + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.include module +---------------------------------- + +.. automodule:: pyams_content_es.include + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.index module +-------------------------------- + +.. automodule:: pyams_content_es.index + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.process module +---------------------------------- + +.. automodule:: pyams_content_es.process + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.site module +------------------------------- + +.. automodule:: pyams_content_es.site + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.utility module +---------------------------------- + +.. automodule:: pyams_content_es.utility + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_content_es + :members: + :undoc-members: + :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content_es/pyams_content_es.scripts.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_content_es/pyams_content_es.scripts.rst Wed Apr 04 15:19:33 2018 +0200 @@ -0,0 +1,22 @@ +pyams\_content\_es\.scripts package +=================================== + +Submodules +---------- + +pyams\_content\_es\.scripts\.index module +----------------------------------------- + +.. automodule:: pyams_content_es.scripts.index + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_content_es.scripts + :members: + :undoc-members: + :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content_es/pyams_content_es.tests.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_content_es/pyams_content_es.tests.rst Wed Apr 04 15:19:33 2018 +0200 @@ -0,0 +1,30 @@ +pyams\_content\_es\.tests package +================================= + +Submodules +---------- + +pyams\_content\_es\.tests\.test\_utilsdocs module +------------------------------------------------- + +.. automodule:: pyams_content_es.tests.test_utilsdocs + :members: + :undoc-members: + :show-inheritance: + +pyams\_content\_es\.tests\.test\_utilsdocstrings module +------------------------------------------------------- + +.. automodule:: pyams_content_es.tests.test_utilsdocstrings + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_content_es.tests + :members: + :undoc-members: + :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_content_es/pyams_content_es.zmi.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/pyams_content_es/pyams_content_es.zmi.rst Wed Apr 04 15:19:33 2018 +0200 @@ -0,0 +1,22 @@ +pyams\_content\_es\.zmi package +=============================== + +Submodules +---------- + +pyams\_content\_es\.zmi\.test module +------------------------------------ + +.. automodule:: pyams_content_es.zmi.test + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyams_content_es.zmi + :members: + :undoc-members: + :show-inheritance: diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_gis/pyams_gis.rst --- a/src/source/pyams_gis/pyams_gis.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_gis/pyams_gis.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_gis: + pyams\_gis package ================== diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_ldap/pyams_ldap.rst --- a/src/source/pyams_ldap/pyams_ldap.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_ldap/pyams_ldap.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_ldap: + pyams\_ldap package =================== diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_mail/pyams_mail.rst --- a/src/source/pyams_mail/pyams_mail.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_mail/pyams_mail.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_mail: + pyams\_mail package =================== diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_media/pyams_media.rst --- a/src/source/pyams_media/pyams_media.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_media/pyams_media.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_media: + pyams\_media package ==================== diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_portal/pyams_portal.rst --- a/src/source/pyams_portal/pyams_portal.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_portal/pyams_portal.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_portal: + pyams\_portal package ===================== diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_scheduler/pyams_scheduler.rst --- a/src/source/pyams_scheduler/pyams_scheduler.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_scheduler/pyams_scheduler.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_scheduler: + pyams\_scheduler package ======================== diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_sequence/pyams_sequence.rst --- a/src/source/pyams_sequence/pyams_sequence.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_sequence/pyams_sequence.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_sequence: + pyams\_sequence package ======================= diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_workflow/pyams_workflow.rst --- a/src/source/pyams_workflow/pyams_workflow.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_workflow/pyams_workflow.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_workflow: + pyams\_workflow package ======================= diff -r 475ba5e42666 -r 55a05201f18c src/source/pyams_zmq/pyams_zmq.rst --- a/src/source/pyams_zmq/pyams_zmq.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/pyams_zmq/pyams_zmq.rst Wed Apr 04 15:19:33 2018 +0200 @@ -1,3 +1,5 @@ +.. _pyams_zmq: + pyams\_zmq package ================== diff -r 475ba5e42666 -r 55a05201f18c src/source/quickstart.rst --- a/src/source/quickstart.rst Wed Apr 04 10:33:01 2018 +0200 +++ b/src/source/quickstart.rst Wed Apr 04 15:19:33 2018 +0200 @@ -256,8 +256,8 @@ (env) $ ./bin/pyams_upgrade etc/development.ini -4. Start application -++++++++++++++++++++ +4. Starting application ++++++++++++++++++++++++ Application is ready to run! Start the application: @@ -283,4 +283,4 @@ - Password: admin **You must change it as soon as possible!** - + (see :ref:`pyams_security`)!!.