From ef2324e92d382155fdebae1ad5f5c64306277cb5 Mon Sep 17 00:00:00 2001 From: Griatch Date: Thu, 18 Jun 2020 23:30:11 +0200 Subject: [PATCH] Customize API look, up sphinx version --- docs/Makefile | 14 +- docs/requirements.txt | 4 +- docs/source/_static/basic.css | 4 +- docs/source/_static/nature.css | 48 +++- docs/source/api/evennia.accounts.accounts.rst | 7 + docs/source/api/evennia.accounts.admin.rst | 7 + docs/source/api/evennia.accounts.bots.rst | 7 + docs/source/api/evennia.accounts.manager.rst | 7 + .../api/evennia.accounts.migrations.rst | 83 ------ docs/source/api/evennia.accounts.models.rst | 7 + docs/source/api/evennia.accounts.rst | 64 +---- docs/source/api/evennia.accounts.tests.rst | 7 + .../api/evennia.commands.cmdhandler.rst | 7 + .../source/api/evennia.commands.cmdparser.rst | 7 + docs/source/api/evennia.commands.cmdset.rst | 7 + .../api/evennia.commands.cmdsethandler.rst | 7 + docs/source/api/evennia.commands.command.rst | 7 + .../api/evennia.commands.default.account.rst | 7 + .../api/evennia.commands.default.admin.rst | 7 + .../evennia.commands.default.batchprocess.rst | 7 + .../api/evennia.commands.default.building.rst | 7 + ...vennia.commands.default.cmdset_account.rst | 7 + ...nnia.commands.default.cmdset_character.rst | 7 + ...vennia.commands.default.cmdset_session.rst | 7 + ...nia.commands.default.cmdset_unloggedin.rst | 7 + .../api/evennia.commands.default.comms.rst | 7 + .../api/evennia.commands.default.general.rst | 7 + .../api/evennia.commands.default.help.rst | 7 + .../evennia.commands.default.muxcommand.rst | 7 + docs/source/api/evennia.commands.default.rst | 147 ++-------- .../evennia.commands.default.syscommands.rst | 7 + .../api/evennia.commands.default.system.rst | 7 + .../api/evennia.commands.default.tests.rst | 7 + .../evennia.commands.default.unloggedin.rst | 7 + docs/source/api/evennia.commands.rst | 58 +--- docs/source/api/evennia.commands.tests.rst | 7 + docs/source/api/evennia.comms.admin.rst | 7 + .../api/evennia.comms.channelhandler.rst | 7 + docs/source/api/evennia.comms.comms.rst | 7 + docs/source/api/evennia.comms.managers.rst | 7 + docs/source/api/evennia.comms.migrations.rst | 163 ----------- docs/source/api/evennia.comms.models.rst | 7 + docs/source/api/evennia.comms.rst | 64 +---- docs/source/api/evennia.comms.tests.rst | 7 + .../evennia.contrib.awsstorage.aws_s3_cdn.rst | 7 + .../source/api/evennia.contrib.awsstorage.rst | 21 +- .../api/evennia.contrib.awsstorage.tests.rst | 7 + docs/source/api/evennia.contrib.barter.rst | 7 + .../api/evennia.contrib.building_menu.rst | 7 + docs/source/api/evennia.contrib.chargen.rst | 7 + docs/source/api/evennia.contrib.clothing.rst | 7 + .../api/evennia.contrib.color_markups.rst | 7 + .../api/evennia.contrib.custom_gametime.rst | 7 + docs/source/api/evennia.contrib.dice.rst | 7 + .../api/evennia.contrib.email_login.rst | 7 + .../api/evennia.contrib.extended_room.rst | 7 + docs/source/api/evennia.contrib.fieldfill.rst | 7 + docs/source/api/evennia.contrib.gendersub.rst | 7 + .../source/api/evennia.contrib.health_bar.rst | 7 + ....contrib.ingame_python.callbackhandler.rst | 7 + ...evennia.contrib.ingame_python.commands.rst | 7 + ...ennia.contrib.ingame_python.eventfuncs.rst | 7 + .../api/evennia.contrib.ingame_python.rst | 66 +---- .../evennia.contrib.ingame_python.scripts.rst | 7 + .../evennia.contrib.ingame_python.tests.rst | 7 + ...nnia.contrib.ingame_python.typeclasses.rst | 7 + .../evennia.contrib.ingame_python.utils.rst | 7 + docs/source/api/evennia.contrib.mail.rst | 7 + .../source/api/evennia.contrib.mapbuilder.rst | 7 + .../source/api/evennia.contrib.menu_login.rst | 7 + .../api/evennia.contrib.multidescer.rst | 7 + docs/source/api/evennia.contrib.puzzles.rst | 7 + ...vennia.contrib.random_string_generator.rst | 7 + .../source/api/evennia.contrib.rplanguage.rst | 7 + docs/source/api/evennia.contrib.rpsystem.rst | 7 + docs/source/api/evennia.contrib.rst | 265 +++--------------- ...nnia.contrib.security.auditing.outputs.rst | 7 + .../api/evennia.contrib.security.auditing.rst | 30 +- ...ennia.contrib.security.auditing.server.rst | 7 + ...vennia.contrib.security.auditing.tests.rst | 7 + docs/source/api/evennia.contrib.security.rst | 3 +- .../source/api/evennia.contrib.simpledoor.rst | 7 + docs/source/api/evennia.contrib.slow_exit.rst | 7 + .../api/evennia.contrib.talking_npc.rst | 7 + .../api/evennia.contrib.test_traits.rst | 7 + docs/source/api/evennia.contrib.tests.rst | 7 + docs/source/api/evennia.contrib.traits.rst | 7 + .../api/evennia.contrib.tree_select.rst | 7 + .../source/api/evennia.contrib.turnbattle.rst | 48 +--- .../evennia.contrib.turnbattle.tb_basic.rst | 7 + .../evennia.contrib.turnbattle.tb_equip.rst | 7 + .../evennia.contrib.turnbattle.tb_items.rst | 7 + .../evennia.contrib.turnbattle.tb_magic.rst | 7 + .../evennia.contrib.turnbattle.tb_range.rst | 7 + ...ontrib.tutorial_examples.bodyfunctions.rst | 7 + ...ib.tutorial_examples.cmdset_red_button.rst | 7 + ...b.tutorial_examples.example_batch_code.rst | 7 + ...a.contrib.tutorial_examples.red_button.rst | 7 + ...b.tutorial_examples.red_button_scripts.rst | 7 + .../api/evennia.contrib.tutorial_examples.rst | 57 +--- ...vennia.contrib.tutorial_examples.tests.rst | 7 + .../evennia.contrib.tutorial_world.mob.rst | 7 + ...evennia.contrib.tutorial_world.objects.rst | 7 + .../evennia.contrib.tutorial_world.rooms.rst | 7 + .../api/evennia.contrib.tutorial_world.rst | 30 +- .../api/evennia.contrib.unixcommand.rst | 7 + .../source/api/evennia.contrib.wilderness.rst | 7 + .../api/evennia.game_template.commands.rst | 27 -- docs/source/api/evennia.game_template.rst | 18 -- .../api/evennia.game_template.server.conf.rst | 131 --------- .../api/evennia.game_template.server.rst | 14 - .../api/evennia.game_template.typeclasses.rst | 67 ----- docs/source/api/evennia.game_template.web.rst | 19 -- .../api/evennia.game_template.world.rst | 19 -- docs/source/api/evennia.help.admin.rst | 7 + docs/source/api/evennia.help.manager.rst | 7 + docs/source/api/evennia.help.migrations.rst | 35 --- docs/source/api/evennia.help.models.rst | 7 + docs/source/api/evennia.help.rst | 37 +-- docs/source/api/evennia.locks.lockfuncs.rst | 7 + docs/source/api/evennia.locks.lockhandler.rst | 7 + docs/source/api/evennia.locks.rst | 30 +- docs/source/api/evennia.locks.tests.rst | 7 + docs/source/api/evennia.objects.admin.rst | 7 + docs/source/api/evennia.objects.manager.rst | 7 + .../source/api/evennia.objects.migrations.rst | 99 ------- docs/source/api/evennia.objects.models.rst | 7 + docs/source/api/evennia.objects.objects.rst | 7 + docs/source/api/evennia.objects.rst | 55 +--- docs/source/api/evennia.objects.tests.rst | 7 + docs/source/api/evennia.prototypes.menus.rst | 7 + .../api/evennia.prototypes.protfuncs.rst | 7 + .../api/evennia.prototypes.prototypes.rst | 7 + docs/source/api/evennia.prototypes.rst | 48 +--- .../source/api/evennia.prototypes.spawner.rst | 7 + docs/source/api/evennia.prototypes.tests.rst | 7 + docs/source/api/evennia.rst | 14 +- docs/source/api/evennia.scripts.admin.rst | 7 + docs/source/api/evennia.scripts.manager.rst | 7 + .../source/api/evennia.scripts.migrations.rst | 115 -------- docs/source/api/evennia.scripts.models.rst | 7 + .../api/evennia.scripts.monitorhandler.rst | 7 + docs/source/api/evennia.scripts.rst | 91 +----- .../api/evennia.scripts.scripthandler.rst | 7 + docs/source/api/evennia.scripts.scripts.rst | 7 + .../api/evennia.scripts.taskhandler.rst | 7 + docs/source/api/evennia.scripts.tests.rst | 7 + .../api/evennia.scripts.tickerhandler.rst | 7 + docs/source/api/evennia.server.admin.rst | 7 + docs/source/api/evennia.server.amp_client.rst | 7 + .../api/evennia.server.connection_wizard.rst | 7 + .../api/evennia.server.deprecations.rst | 7 + .../api/evennia.server.evennia_launcher.rst | 7 + ...vennia.server.game_index_client.client.rst | 7 + .../api/evennia.server.game_index_client.rst | 21 +- ...ennia.server.game_index_client.service.rst | 7 + .../api/evennia.server.initial_setup.rst | 7 + docs/source/api/evennia.server.inputfuncs.rst | 7 + docs/source/api/evennia.server.manager.rst | 7 + docs/source/api/evennia.server.migrations.rst | 27 -- docs/source/api/evennia.server.models.rst | 7 + docs/source/api/evennia.server.portal.amp.rst | 7 + .../api/evennia.server.portal.amp_server.rst | 7 + .../api/evennia.server.portal.grapevine.rst | 7 + docs/source/api/evennia.server.portal.irc.rst | 7 + .../source/api/evennia.server.portal.mccp.rst | 7 + .../source/api/evennia.server.portal.mssp.rst | 7 + docs/source/api/evennia.server.portal.mxp.rst | 7 + .../source/api/evennia.server.portal.naws.rst | 7 + .../api/evennia.server.portal.portal.rst | 7 + ...nia.server.portal.portalsessionhandler.rst | 7 + docs/source/api/evennia.server.portal.rss.rst | 7 + docs/source/api/evennia.server.portal.rst | 192 ++----------- docs/source/api/evennia.server.portal.ssh.rst | 7 + docs/source/api/evennia.server.portal.ssl.rst | 7 + .../api/evennia.server.portal.suppress_ga.rst | 7 + .../api/evennia.server.portal.telnet.rst | 7 + .../api/evennia.server.portal.telnet_oob.rst | 7 + .../api/evennia.server.portal.telnet_ssl.rst | 7 + .../api/evennia.server.portal.tests.rst | 7 + .../api/evennia.server.portal.ttype.rst | 7 + .../api/evennia.server.portal.webclient.rst | 7 + .../evennia.server.portal.webclient_ajax.rst | 7 + .../evennia.server.profiling.dummyrunner.rst | 7 + ....server.profiling.dummyrunner_settings.rst | 7 + .../api/evennia.server.profiling.memplot.rst | 7 + docs/source/api/evennia.server.profiling.rst | 66 +---- ...vennia.server.profiling.settings_mixin.rst | 7 + .../evennia.server.profiling.test_queries.rst | 7 + .../api/evennia.server.profiling.tests.rst | 7 + .../evennia.server.profiling.timetrace.rst | 7 + docs/source/api/evennia.server.rst | 158 ++--------- docs/source/api/evennia.server.server.rst | 7 + .../api/evennia.server.serversession.rst | 7 + docs/source/api/evennia.server.session.rst | 7 + .../api/evennia.server.sessionhandler.rst | 7 + docs/source/api/evennia.server.signals.rst | 7 + docs/source/api/evennia.server.tests.rst | 57 +--- ...ennia.server.tests.test_amp_connection.rst | 7 + ...vennia.server.tests.test_initial_setup.rst | 7 + .../evennia.server.tests.test_launcher.rst | 7 + .../api/evennia.server.tests.test_misc.rst | 7 + .../api/evennia.server.tests.test_server.rst | 7 + .../api/evennia.server.tests.testrunner.rst | 7 + docs/source/api/evennia.server.throttle.rst | 7 + docs/source/api/evennia.server.validators.rst | 7 + docs/source/api/evennia.server.webserver.rst | 7 + docs/source/api/evennia.settings_default.rst | 7 + docs/source/api/evennia.typeclasses.admin.rst | 7 + .../api/evennia.typeclasses.attributes.rst | 7 + .../api/evennia.typeclasses.managers.rst | 7 + .../api/evennia.typeclasses.migrations.rst | 115 -------- .../source/api/evennia.typeclasses.models.rst | 7 + docs/source/api/evennia.typeclasses.rst | 64 +---- docs/source/api/evennia.typeclasses.tags.rst | 7 + docs/source/api/evennia.typeclasses.tests.rst | 7 + docs/source/api/evennia.utils.ansi.rst | 7 + .../api/evennia.utils.batchprocessors.rst | 7 + docs/source/api/evennia.utils.containers.rst | 7 + docs/source/api/evennia.utils.create.rst | 7 + docs/source/api/evennia.utils.dbserialize.rst | 7 + docs/source/api/evennia.utils.eveditor.rst | 7 + docs/source/api/evennia.utils.evform.rst | 7 + docs/source/api/evennia.utils.evmenu.rst | 7 + docs/source/api/evennia.utils.evmore.rst | 7 + docs/source/api/evennia.utils.evtable.rst | 7 + docs/source/api/evennia.utils.gametime.rst | 7 + .../api/evennia.utils.idmapper.manager.rst | 7 + .../api/evennia.utils.idmapper.models.rst | 7 + docs/source/api/evennia.utils.idmapper.rst | 30 +- .../api/evennia.utils.idmapper.tests.rst | 7 + docs/source/api/evennia.utils.inlinefuncs.rst | 7 + docs/source/api/evennia.utils.logger.rst | 7 + .../api/evennia.utils.optionclasses.rst | 7 + .../api/evennia.utils.optionhandler.rst | 7 + docs/source/api/evennia.utils.picklefield.rst | 7 + docs/source/api/evennia.utils.rst | 193 ++----------- docs/source/api/evennia.utils.search.rst | 7 + .../api/evennia.utils.test_resources.rst | 7 + ...vennia.utils.tests.data.evform_example.rst | 7 + ...ia.utils.tests.data.prototypes_example.rst | 7 + docs/source/api/evennia.utils.tests.data.rst | 21 +- docs/source/api/evennia.utils.tests.rst | 103 +------ .../api/evennia.utils.tests.test_ansi.rst | 7 + ...ennia.utils.tests.test_batchprocessors.rst | 7 + ...nnia.utils.tests.test_create_functions.rst | 7 + .../api/evennia.utils.tests.test_eveditor.rst | 7 + .../api/evennia.utils.tests.test_evform.rst | 7 + .../api/evennia.utils.tests.test_evmenu.rst | 7 + .../api/evennia.utils.tests.test_gametime.rst | 7 + .../evennia.utils.tests.test_tagparsing.rst | 7 + .../evennia.utils.tests.test_text2html.rst | 7 + .../api/evennia.utils.tests.test_utils.rst | 7 + ...vennia.utils.tests.test_validatorfuncs.rst | 7 + docs/source/api/evennia.utils.text2html.rst | 7 + docs/source/api/evennia.utils.utils.rst | 7 + .../api/evennia.utils.validatorfuncs.rst | 7 + docs/source/api/evennia.web.api.filters.rst | 7 + .../api/evennia.web.api.permissions.rst | 7 + docs/source/api/evennia.web.api.rst | 57 +--- .../api/evennia.web.api.serializers.rst | 7 + docs/source/api/evennia.web.api.tests.rst | 7 + docs/source/api/evennia.web.api.urls.rst | 7 + docs/source/api/evennia.web.api.views.rst | 7 + docs/source/api/evennia.web.rst | 13 +- docs/source/api/evennia.web.urls.rst | 7 + .../source/api/evennia.web.utils.backends.rst | 7 + .../api/evennia.web.utils.general_context.rst | 7 + .../api/evennia.web.utils.middleware.rst | 7 + docs/source/api/evennia.web.utils.rst | 39 +-- docs/source/api/evennia.web.utils.tests.rst | 7 + docs/source/api/evennia.web.webclient.rst | 21 +- .../source/api/evennia.web.webclient.urls.rst | 7 + .../api/evennia.web.webclient.views.rst | 7 + docs/source/api/evennia.web.website.forms.rst | 7 + docs/source/api/evennia.web.website.rst | 40 +-- ...nnia.web.website.templatetags.addclass.rst | 7 + .../api/evennia.web.website.templatetags.rst | 12 +- docs/source/api/evennia.web.website.tests.rst | 7 + docs/source/api/evennia.web.website.urls.rst | 7 + docs/source/api/evennia.web.website.views.rst | 7 + docs/source/conf.py | 37 ++- 282 files changed, 2021 insertions(+), 2836 deletions(-) create mode 100644 docs/source/api/evennia.accounts.accounts.rst create mode 100644 docs/source/api/evennia.accounts.admin.rst create mode 100644 docs/source/api/evennia.accounts.bots.rst create mode 100644 docs/source/api/evennia.accounts.manager.rst delete mode 100644 docs/source/api/evennia.accounts.migrations.rst create mode 100644 docs/source/api/evennia.accounts.models.rst create mode 100644 docs/source/api/evennia.accounts.tests.rst create mode 100644 docs/source/api/evennia.commands.cmdhandler.rst create mode 100644 docs/source/api/evennia.commands.cmdparser.rst create mode 100644 docs/source/api/evennia.commands.cmdset.rst create mode 100644 docs/source/api/evennia.commands.cmdsethandler.rst create mode 100644 docs/source/api/evennia.commands.command.rst create mode 100644 docs/source/api/evennia.commands.default.account.rst create mode 100644 docs/source/api/evennia.commands.default.admin.rst create mode 100644 docs/source/api/evennia.commands.default.batchprocess.rst create mode 100644 docs/source/api/evennia.commands.default.building.rst create mode 100644 docs/source/api/evennia.commands.default.cmdset_account.rst create mode 100644 docs/source/api/evennia.commands.default.cmdset_character.rst create mode 100644 docs/source/api/evennia.commands.default.cmdset_session.rst create mode 100644 docs/source/api/evennia.commands.default.cmdset_unloggedin.rst create mode 100644 docs/source/api/evennia.commands.default.comms.rst create mode 100644 docs/source/api/evennia.commands.default.general.rst create mode 100644 docs/source/api/evennia.commands.default.help.rst create mode 100644 docs/source/api/evennia.commands.default.muxcommand.rst create mode 100644 docs/source/api/evennia.commands.default.syscommands.rst create mode 100644 docs/source/api/evennia.commands.default.system.rst create mode 100644 docs/source/api/evennia.commands.default.tests.rst create mode 100644 docs/source/api/evennia.commands.default.unloggedin.rst create mode 100644 docs/source/api/evennia.commands.tests.rst create mode 100644 docs/source/api/evennia.comms.admin.rst create mode 100644 docs/source/api/evennia.comms.channelhandler.rst create mode 100644 docs/source/api/evennia.comms.comms.rst create mode 100644 docs/source/api/evennia.comms.managers.rst delete mode 100644 docs/source/api/evennia.comms.migrations.rst create mode 100644 docs/source/api/evennia.comms.models.rst create mode 100644 docs/source/api/evennia.comms.tests.rst create mode 100644 docs/source/api/evennia.contrib.awsstorage.aws_s3_cdn.rst create mode 100644 docs/source/api/evennia.contrib.awsstorage.tests.rst create mode 100644 docs/source/api/evennia.contrib.barter.rst create mode 100644 docs/source/api/evennia.contrib.building_menu.rst create mode 100644 docs/source/api/evennia.contrib.chargen.rst create mode 100644 docs/source/api/evennia.contrib.clothing.rst create mode 100644 docs/source/api/evennia.contrib.color_markups.rst create mode 100644 docs/source/api/evennia.contrib.custom_gametime.rst create mode 100644 docs/source/api/evennia.contrib.dice.rst create mode 100644 docs/source/api/evennia.contrib.email_login.rst create mode 100644 docs/source/api/evennia.contrib.extended_room.rst create mode 100644 docs/source/api/evennia.contrib.fieldfill.rst create mode 100644 docs/source/api/evennia.contrib.gendersub.rst create mode 100644 docs/source/api/evennia.contrib.health_bar.rst create mode 100644 docs/source/api/evennia.contrib.ingame_python.callbackhandler.rst create mode 100644 docs/source/api/evennia.contrib.ingame_python.commands.rst create mode 100644 docs/source/api/evennia.contrib.ingame_python.eventfuncs.rst create mode 100644 docs/source/api/evennia.contrib.ingame_python.scripts.rst create mode 100644 docs/source/api/evennia.contrib.ingame_python.tests.rst create mode 100644 docs/source/api/evennia.contrib.ingame_python.typeclasses.rst create mode 100644 docs/source/api/evennia.contrib.ingame_python.utils.rst create mode 100644 docs/source/api/evennia.contrib.mail.rst create mode 100644 docs/source/api/evennia.contrib.mapbuilder.rst create mode 100644 docs/source/api/evennia.contrib.menu_login.rst create mode 100644 docs/source/api/evennia.contrib.multidescer.rst create mode 100644 docs/source/api/evennia.contrib.puzzles.rst create mode 100644 docs/source/api/evennia.contrib.random_string_generator.rst create mode 100644 docs/source/api/evennia.contrib.rplanguage.rst create mode 100644 docs/source/api/evennia.contrib.rpsystem.rst create mode 100644 docs/source/api/evennia.contrib.security.auditing.outputs.rst create mode 100644 docs/source/api/evennia.contrib.security.auditing.server.rst create mode 100644 docs/source/api/evennia.contrib.security.auditing.tests.rst create mode 100644 docs/source/api/evennia.contrib.simpledoor.rst create mode 100644 docs/source/api/evennia.contrib.slow_exit.rst create mode 100644 docs/source/api/evennia.contrib.talking_npc.rst create mode 100644 docs/source/api/evennia.contrib.test_traits.rst create mode 100644 docs/source/api/evennia.contrib.tests.rst create mode 100644 docs/source/api/evennia.contrib.traits.rst create mode 100644 docs/source/api/evennia.contrib.tree_select.rst create mode 100644 docs/source/api/evennia.contrib.turnbattle.tb_basic.rst create mode 100644 docs/source/api/evennia.contrib.turnbattle.tb_equip.rst create mode 100644 docs/source/api/evennia.contrib.turnbattle.tb_items.rst create mode 100644 docs/source/api/evennia.contrib.turnbattle.tb_magic.rst create mode 100644 docs/source/api/evennia.contrib.turnbattle.tb_range.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_examples.bodyfunctions.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_examples.cmdset_red_button.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_examples.example_batch_code.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_examples.red_button.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_examples.red_button_scripts.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_examples.tests.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_world.mob.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_world.objects.rst create mode 100644 docs/source/api/evennia.contrib.tutorial_world.rooms.rst create mode 100644 docs/source/api/evennia.contrib.unixcommand.rst create mode 100644 docs/source/api/evennia.contrib.wilderness.rst delete mode 100644 docs/source/api/evennia.game_template.commands.rst delete mode 100644 docs/source/api/evennia.game_template.rst delete mode 100644 docs/source/api/evennia.game_template.server.conf.rst delete mode 100644 docs/source/api/evennia.game_template.server.rst delete mode 100644 docs/source/api/evennia.game_template.typeclasses.rst delete mode 100644 docs/source/api/evennia.game_template.web.rst delete mode 100644 docs/source/api/evennia.game_template.world.rst create mode 100644 docs/source/api/evennia.help.admin.rst create mode 100644 docs/source/api/evennia.help.manager.rst delete mode 100644 docs/source/api/evennia.help.migrations.rst create mode 100644 docs/source/api/evennia.help.models.rst create mode 100644 docs/source/api/evennia.locks.lockfuncs.rst create mode 100644 docs/source/api/evennia.locks.lockhandler.rst create mode 100644 docs/source/api/evennia.locks.tests.rst create mode 100644 docs/source/api/evennia.objects.admin.rst create mode 100644 docs/source/api/evennia.objects.manager.rst delete mode 100644 docs/source/api/evennia.objects.migrations.rst create mode 100644 docs/source/api/evennia.objects.models.rst create mode 100644 docs/source/api/evennia.objects.objects.rst create mode 100644 docs/source/api/evennia.objects.tests.rst create mode 100644 docs/source/api/evennia.prototypes.menus.rst create mode 100644 docs/source/api/evennia.prototypes.protfuncs.rst create mode 100644 docs/source/api/evennia.prototypes.prototypes.rst create mode 100644 docs/source/api/evennia.prototypes.spawner.rst create mode 100644 docs/source/api/evennia.prototypes.tests.rst create mode 100644 docs/source/api/evennia.scripts.admin.rst create mode 100644 docs/source/api/evennia.scripts.manager.rst delete mode 100644 docs/source/api/evennia.scripts.migrations.rst create mode 100644 docs/source/api/evennia.scripts.models.rst create mode 100644 docs/source/api/evennia.scripts.monitorhandler.rst create mode 100644 docs/source/api/evennia.scripts.scripthandler.rst create mode 100644 docs/source/api/evennia.scripts.scripts.rst create mode 100644 docs/source/api/evennia.scripts.taskhandler.rst create mode 100644 docs/source/api/evennia.scripts.tests.rst create mode 100644 docs/source/api/evennia.scripts.tickerhandler.rst create mode 100644 docs/source/api/evennia.server.admin.rst create mode 100644 docs/source/api/evennia.server.amp_client.rst create mode 100644 docs/source/api/evennia.server.connection_wizard.rst create mode 100644 docs/source/api/evennia.server.deprecations.rst create mode 100644 docs/source/api/evennia.server.evennia_launcher.rst create mode 100644 docs/source/api/evennia.server.game_index_client.client.rst create mode 100644 docs/source/api/evennia.server.game_index_client.service.rst create mode 100644 docs/source/api/evennia.server.initial_setup.rst create mode 100644 docs/source/api/evennia.server.inputfuncs.rst create mode 100644 docs/source/api/evennia.server.manager.rst delete mode 100644 docs/source/api/evennia.server.migrations.rst create mode 100644 docs/source/api/evennia.server.models.rst create mode 100644 docs/source/api/evennia.server.portal.amp.rst create mode 100644 docs/source/api/evennia.server.portal.amp_server.rst create mode 100644 docs/source/api/evennia.server.portal.grapevine.rst create mode 100644 docs/source/api/evennia.server.portal.irc.rst create mode 100644 docs/source/api/evennia.server.portal.mccp.rst create mode 100644 docs/source/api/evennia.server.portal.mssp.rst create mode 100644 docs/source/api/evennia.server.portal.mxp.rst create mode 100644 docs/source/api/evennia.server.portal.naws.rst create mode 100644 docs/source/api/evennia.server.portal.portal.rst create mode 100644 docs/source/api/evennia.server.portal.portalsessionhandler.rst create mode 100644 docs/source/api/evennia.server.portal.rss.rst create mode 100644 docs/source/api/evennia.server.portal.ssh.rst create mode 100644 docs/source/api/evennia.server.portal.ssl.rst create mode 100644 docs/source/api/evennia.server.portal.suppress_ga.rst create mode 100644 docs/source/api/evennia.server.portal.telnet.rst create mode 100644 docs/source/api/evennia.server.portal.telnet_oob.rst create mode 100644 docs/source/api/evennia.server.portal.telnet_ssl.rst create mode 100644 docs/source/api/evennia.server.portal.tests.rst create mode 100644 docs/source/api/evennia.server.portal.ttype.rst create mode 100644 docs/source/api/evennia.server.portal.webclient.rst create mode 100644 docs/source/api/evennia.server.portal.webclient_ajax.rst create mode 100644 docs/source/api/evennia.server.profiling.dummyrunner.rst create mode 100644 docs/source/api/evennia.server.profiling.dummyrunner_settings.rst create mode 100644 docs/source/api/evennia.server.profiling.memplot.rst create mode 100644 docs/source/api/evennia.server.profiling.settings_mixin.rst create mode 100644 docs/source/api/evennia.server.profiling.test_queries.rst create mode 100644 docs/source/api/evennia.server.profiling.tests.rst create mode 100644 docs/source/api/evennia.server.profiling.timetrace.rst create mode 100644 docs/source/api/evennia.server.server.rst create mode 100644 docs/source/api/evennia.server.serversession.rst create mode 100644 docs/source/api/evennia.server.session.rst create mode 100644 docs/source/api/evennia.server.sessionhandler.rst create mode 100644 docs/source/api/evennia.server.signals.rst create mode 100644 docs/source/api/evennia.server.tests.test_amp_connection.rst create mode 100644 docs/source/api/evennia.server.tests.test_initial_setup.rst create mode 100644 docs/source/api/evennia.server.tests.test_launcher.rst create mode 100644 docs/source/api/evennia.server.tests.test_misc.rst create mode 100644 docs/source/api/evennia.server.tests.test_server.rst create mode 100644 docs/source/api/evennia.server.tests.testrunner.rst create mode 100644 docs/source/api/evennia.server.throttle.rst create mode 100644 docs/source/api/evennia.server.validators.rst create mode 100644 docs/source/api/evennia.server.webserver.rst create mode 100644 docs/source/api/evennia.settings_default.rst create mode 100644 docs/source/api/evennia.typeclasses.admin.rst create mode 100644 docs/source/api/evennia.typeclasses.attributes.rst create mode 100644 docs/source/api/evennia.typeclasses.managers.rst delete mode 100644 docs/source/api/evennia.typeclasses.migrations.rst create mode 100644 docs/source/api/evennia.typeclasses.models.rst create mode 100644 docs/source/api/evennia.typeclasses.tags.rst create mode 100644 docs/source/api/evennia.typeclasses.tests.rst create mode 100644 docs/source/api/evennia.utils.ansi.rst create mode 100644 docs/source/api/evennia.utils.batchprocessors.rst create mode 100644 docs/source/api/evennia.utils.containers.rst create mode 100644 docs/source/api/evennia.utils.create.rst create mode 100644 docs/source/api/evennia.utils.dbserialize.rst create mode 100644 docs/source/api/evennia.utils.eveditor.rst create mode 100644 docs/source/api/evennia.utils.evform.rst create mode 100644 docs/source/api/evennia.utils.evmenu.rst create mode 100644 docs/source/api/evennia.utils.evmore.rst create mode 100644 docs/source/api/evennia.utils.evtable.rst create mode 100644 docs/source/api/evennia.utils.gametime.rst create mode 100644 docs/source/api/evennia.utils.idmapper.manager.rst create mode 100644 docs/source/api/evennia.utils.idmapper.models.rst create mode 100644 docs/source/api/evennia.utils.idmapper.tests.rst create mode 100644 docs/source/api/evennia.utils.inlinefuncs.rst create mode 100644 docs/source/api/evennia.utils.logger.rst create mode 100644 docs/source/api/evennia.utils.optionclasses.rst create mode 100644 docs/source/api/evennia.utils.optionhandler.rst create mode 100644 docs/source/api/evennia.utils.picklefield.rst create mode 100644 docs/source/api/evennia.utils.search.rst create mode 100644 docs/source/api/evennia.utils.test_resources.rst create mode 100644 docs/source/api/evennia.utils.tests.data.evform_example.rst create mode 100644 docs/source/api/evennia.utils.tests.data.prototypes_example.rst create mode 100644 docs/source/api/evennia.utils.tests.test_ansi.rst create mode 100644 docs/source/api/evennia.utils.tests.test_batchprocessors.rst create mode 100644 docs/source/api/evennia.utils.tests.test_create_functions.rst create mode 100644 docs/source/api/evennia.utils.tests.test_eveditor.rst create mode 100644 docs/source/api/evennia.utils.tests.test_evform.rst create mode 100644 docs/source/api/evennia.utils.tests.test_evmenu.rst create mode 100644 docs/source/api/evennia.utils.tests.test_gametime.rst create mode 100644 docs/source/api/evennia.utils.tests.test_tagparsing.rst create mode 100644 docs/source/api/evennia.utils.tests.test_text2html.rst create mode 100644 docs/source/api/evennia.utils.tests.test_utils.rst create mode 100644 docs/source/api/evennia.utils.tests.test_validatorfuncs.rst create mode 100644 docs/source/api/evennia.utils.text2html.rst create mode 100644 docs/source/api/evennia.utils.utils.rst create mode 100644 docs/source/api/evennia.utils.validatorfuncs.rst create mode 100644 docs/source/api/evennia.web.api.filters.rst create mode 100644 docs/source/api/evennia.web.api.permissions.rst create mode 100644 docs/source/api/evennia.web.api.serializers.rst create mode 100644 docs/source/api/evennia.web.api.tests.rst create mode 100644 docs/source/api/evennia.web.api.urls.rst create mode 100644 docs/source/api/evennia.web.api.views.rst create mode 100644 docs/source/api/evennia.web.urls.rst create mode 100644 docs/source/api/evennia.web.utils.backends.rst create mode 100644 docs/source/api/evennia.web.utils.general_context.rst create mode 100644 docs/source/api/evennia.web.utils.middleware.rst create mode 100644 docs/source/api/evennia.web.utils.tests.rst create mode 100644 docs/source/api/evennia.web.webclient.urls.rst create mode 100644 docs/source/api/evennia.web.webclient.views.rst create mode 100644 docs/source/api/evennia.web.website.forms.rst create mode 100644 docs/source/api/evennia.web.website.templatetags.addclass.rst create mode 100644 docs/source/api/evennia.web.website.tests.rst create mode 100644 docs/source/api/evennia.web.website.urls.rst create mode 100644 docs/source/api/evennia.web.website.views.rst diff --git a/docs/Makefile b/docs/Makefile index 43d5a32735..b76db79476 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -7,9 +7,9 @@ SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SPHINXMULTIVERSION ?= sphinx-multiversion SPHINXAPIDOC ?= sphinx-apidoc -SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force +SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force --separate SPHINXAPIDOCENV = members,undoc-members,show-inheritance -SPHINXAPIDOCEXCLUDE = */migrations/* +SPHINXAPIDOCEXCLUDE = ../*/migrations/* ../evennia/game_template/* SOURCEDIR = source BUILDDIR = build AUTODOCDIR = $(SOURCEDIR)/api @@ -55,11 +55,21 @@ _multiversion-check-env: _clean_api_index: rm source/api/* +# remove supervluous 'module' and 'package' text from api headers +_reformat_apidoc_headers: + for f in source/api/*.rst; do\ + perl -pi -e 's/(module|package)$$// if $$. == 1' $$f ;\ + done + _autodoc-index: + make _clean_api_index @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE) + make _reformat_apidoc_headers _multiversion-autodoc-index: + make _clean_api_index @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE) + make _reformat_apidoc_headers git diff-index --quiet HEAD || git commit -a -m "Updated API autodoc index." _html-build: diff --git a/docs/requirements.txt b/docs/requirements.txt index 1195df76d3..3f53d4a0a0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,7 @@ # requirements for building the docs -sphinx==2.4.4 -sphinx-multiversion==0.1.1 +sphinx==3.1.1 +sphinx-multiversion==0.2.3 # recommonmark custom branch with evennia-specific fixes git+https://github.com/evennia/recommonmark.git@evennia-mods#egg=recommonmark diff --git a/docs/source/_static/basic.css b/docs/source/_static/basic.css index e3f1c17622..e89235ddc2 100644 --- a/docs/source/_static/basic.css +++ b/docs/source/_static/basic.css @@ -569,7 +569,7 @@ dd { } dt:target, span.highlighted { - background-color: #fbe54e; + background-color: #fffbde; } rect.highlighted { @@ -704,7 +704,7 @@ div.literal-block-wrapper div.highlight { code.descname { background-color: transparent; font-weight: bold; - font-size: 1.2em; + font-size: 0.9em; } code.descclassname { diff --git a/docs/source/_static/nature.css b/docs/source/_static/nature.css index 01a51db1a4..8c2c57e5a0 100644 --- a/docs/source/_static/nature.css +++ b/docs/source/_static/nature.css @@ -297,7 +297,7 @@ code { } div.viewcode-block:target { - background-color: #f4debf; + background-color: #f4e9d9; border-top: 1px solid #ac9; border-bottom: 1px solid #ac9; } @@ -328,3 +328,49 @@ div.code-block-caption { .deprecated { background-color: #fff3f3; } + +/* API-docs custom coloring */ + + +.class { + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; + font-size: 0.9em; + background-color: #f5ffff; + padding: 5px; +} + +.method { + background-color: #e3ecec; + padding: 5px; + font-size: 1.0em; +} + +.sig-param { + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; +} + +.property { + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; +} + +dl.class > dd > p { + font-style: italic; +} + +dl.method > dd > p { + font-style: italic; +} + +code.descname { + font-size: 0.9em; +} + +.function { + background-color: #eff; + padding: 5px; +} + +.exception { + background-color: #fff9f9; + padding: 5px; +} diff --git a/docs/source/api/evennia.accounts.accounts.rst b/docs/source/api/evennia.accounts.accounts.rst new file mode 100644 index 0000000000..5e256eb18b --- /dev/null +++ b/docs/source/api/evennia.accounts.accounts.rst @@ -0,0 +1,7 @@ +evennia.accounts.accounts +================================ + +.. automodule:: evennia.accounts.accounts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.admin.rst b/docs/source/api/evennia.accounts.admin.rst new file mode 100644 index 0000000000..6c63cee11c --- /dev/null +++ b/docs/source/api/evennia.accounts.admin.rst @@ -0,0 +1,7 @@ +evennia.accounts.admin +============================= + +.. automodule:: evennia.accounts.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.bots.rst b/docs/source/api/evennia.accounts.bots.rst new file mode 100644 index 0000000000..713986b696 --- /dev/null +++ b/docs/source/api/evennia.accounts.bots.rst @@ -0,0 +1,7 @@ +evennia.accounts.bots +============================ + +.. automodule:: evennia.accounts.bots + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.manager.rst b/docs/source/api/evennia.accounts.manager.rst new file mode 100644 index 0000000000..0d3929ffeb --- /dev/null +++ b/docs/source/api/evennia.accounts.manager.rst @@ -0,0 +1,7 @@ +evennia.accounts.manager +=============================== + +.. automodule:: evennia.accounts.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.migrations.rst b/docs/source/api/evennia.accounts.migrations.rst deleted file mode 100644 index 791b6b15df..0000000000 --- a/docs/source/api/evennia.accounts.migrations.rst +++ /dev/null @@ -1,83 +0,0 @@ -evennia.accounts.migrations package -=================================== - -.. automodule:: evennia.accounts.migrations - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.accounts.migrations.0001\_initial module ------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0001_initial - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0002\_move\_defaults module -------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0002_move_defaults - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0003\_auto\_20150209\_2234 module -------------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0003_auto_20150209_2234 - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0004\_auto\_20150403\_2339 module -------------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0004_auto_20150403_2339 - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0005\_auto\_20160905\_0902 module -------------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0005_auto_20160905_0902 - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0006\_auto\_20170606\_1731 module -------------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0006_auto_20170606_1731 - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0007\_copy\_player\_to\_account module ------------------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0007_copy_player_to_account - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0008\_auto\_20190128\_1820 module -------------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0008_auto_20190128_1820 - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.migrations.0009\_auto\_20191025\_0831 module -------------------------------------------------------------- - -.. automodule:: evennia.accounts.migrations.0009_auto_20191025_0831 - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.accounts.models.rst b/docs/source/api/evennia.accounts.models.rst new file mode 100644 index 0000000000..2a87b70eca --- /dev/null +++ b/docs/source/api/evennia.accounts.models.rst @@ -0,0 +1,7 @@ +evennia.accounts.models +============================== + +.. automodule:: evennia.accounts.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.accounts.rst b/docs/source/api/evennia.accounts.rst index 79426e7b03..8d1eee50bb 100644 --- a/docs/source/api/evennia.accounts.rst +++ b/docs/source/api/evennia.accounts.rst @@ -1,4 +1,4 @@ -evennia.accounts package +evennia.accounts ======================== .. automodule:: evennia.accounts @@ -6,61 +6,15 @@ evennia.accounts package :undoc-members: :show-inheritance: -Subpackages ------------ - -.. toctree:: - - evennia.accounts.migrations - Submodules ---------- -evennia.accounts.accounts module --------------------------------- - -.. automodule:: evennia.accounts.accounts - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.admin module ------------------------------ - -.. automodule:: evennia.accounts.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.bots module ----------------------------- - -.. automodule:: evennia.accounts.bots - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.manager module -------------------------------- - -.. automodule:: evennia.accounts.manager - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.models module ------------------------------- - -.. automodule:: evennia.accounts.models - :members: - :undoc-members: - :show-inheritance: - -evennia.accounts.tests module ------------------------------ - -.. automodule:: evennia.accounts.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.accounts.accounts + evennia.accounts.admin + evennia.accounts.bots + evennia.accounts.manager + evennia.accounts.models + evennia.accounts.tests diff --git a/docs/source/api/evennia.accounts.tests.rst b/docs/source/api/evennia.accounts.tests.rst new file mode 100644 index 0000000000..1aa7640fb8 --- /dev/null +++ b/docs/source/api/evennia.accounts.tests.rst @@ -0,0 +1,7 @@ +evennia.accounts.tests +============================= + +.. automodule:: evennia.accounts.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.cmdhandler.rst b/docs/source/api/evennia.commands.cmdhandler.rst new file mode 100644 index 0000000000..8c13d3afe0 --- /dev/null +++ b/docs/source/api/evennia.commands.cmdhandler.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdhandler +================================== + +.. automodule:: evennia.commands.cmdhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.cmdparser.rst b/docs/source/api/evennia.commands.cmdparser.rst new file mode 100644 index 0000000000..0ae78c86cd --- /dev/null +++ b/docs/source/api/evennia.commands.cmdparser.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdparser +================================= + +.. automodule:: evennia.commands.cmdparser + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.cmdset.rst b/docs/source/api/evennia.commands.cmdset.rst new file mode 100644 index 0000000000..bdaa62aa52 --- /dev/null +++ b/docs/source/api/evennia.commands.cmdset.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdset +============================== + +.. automodule:: evennia.commands.cmdset + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.cmdsethandler.rst b/docs/source/api/evennia.commands.cmdsethandler.rst new file mode 100644 index 0000000000..8c470882a8 --- /dev/null +++ b/docs/source/api/evennia.commands.cmdsethandler.rst @@ -0,0 +1,7 @@ +evennia.commands.cmdsethandler +===================================== + +.. automodule:: evennia.commands.cmdsethandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.command.rst b/docs/source/api/evennia.commands.command.rst new file mode 100644 index 0000000000..dc54d5b0b3 --- /dev/null +++ b/docs/source/api/evennia.commands.command.rst @@ -0,0 +1,7 @@ +evennia.commands.command +=============================== + +.. automodule:: evennia.commands.command + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.account.rst b/docs/source/api/evennia.commands.default.account.rst new file mode 100644 index 0000000000..60b90c7342 --- /dev/null +++ b/docs/source/api/evennia.commands.default.account.rst @@ -0,0 +1,7 @@ +evennia.commands.default.account +======================================= + +.. automodule:: evennia.commands.default.account + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.admin.rst b/docs/source/api/evennia.commands.default.admin.rst new file mode 100644 index 0000000000..83dd6b5d15 --- /dev/null +++ b/docs/source/api/evennia.commands.default.admin.rst @@ -0,0 +1,7 @@ +evennia.commands.default.admin +===================================== + +.. automodule:: evennia.commands.default.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.batchprocess.rst b/docs/source/api/evennia.commands.default.batchprocess.rst new file mode 100644 index 0000000000..3b14019baa --- /dev/null +++ b/docs/source/api/evennia.commands.default.batchprocess.rst @@ -0,0 +1,7 @@ +evennia.commands.default.batchprocess +============================================ + +.. automodule:: evennia.commands.default.batchprocess + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.building.rst b/docs/source/api/evennia.commands.default.building.rst new file mode 100644 index 0000000000..2b34708766 --- /dev/null +++ b/docs/source/api/evennia.commands.default.building.rst @@ -0,0 +1,7 @@ +evennia.commands.default.building +======================================== + +.. automodule:: evennia.commands.default.building + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_account.rst b/docs/source/api/evennia.commands.default.cmdset_account.rst new file mode 100644 index 0000000000..9d1c96533e --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_account.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_account +=============================================== + +.. automodule:: evennia.commands.default.cmdset_account + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_character.rst b/docs/source/api/evennia.commands.default.cmdset_character.rst new file mode 100644 index 0000000000..c859957275 --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_character.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_character +================================================= + +.. automodule:: evennia.commands.default.cmdset_character + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_session.rst b/docs/source/api/evennia.commands.default.cmdset_session.rst new file mode 100644 index 0000000000..a6324f096f --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_session.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_session +=============================================== + +.. automodule:: evennia.commands.default.cmdset_session + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.cmdset_unloggedin.rst b/docs/source/api/evennia.commands.default.cmdset_unloggedin.rst new file mode 100644 index 0000000000..e15cbaf882 --- /dev/null +++ b/docs/source/api/evennia.commands.default.cmdset_unloggedin.rst @@ -0,0 +1,7 @@ +evennia.commands.default.cmdset\_unloggedin +================================================== + +.. automodule:: evennia.commands.default.cmdset_unloggedin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.comms.rst b/docs/source/api/evennia.commands.default.comms.rst new file mode 100644 index 0000000000..7840a59c33 --- /dev/null +++ b/docs/source/api/evennia.commands.default.comms.rst @@ -0,0 +1,7 @@ +evennia.commands.default.comms +===================================== + +.. automodule:: evennia.commands.default.comms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.general.rst b/docs/source/api/evennia.commands.default.general.rst new file mode 100644 index 0000000000..6398464063 --- /dev/null +++ b/docs/source/api/evennia.commands.default.general.rst @@ -0,0 +1,7 @@ +evennia.commands.default.general +======================================= + +.. automodule:: evennia.commands.default.general + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.help.rst b/docs/source/api/evennia.commands.default.help.rst new file mode 100644 index 0000000000..61e2009ef8 --- /dev/null +++ b/docs/source/api/evennia.commands.default.help.rst @@ -0,0 +1,7 @@ +evennia.commands.default.help +==================================== + +.. automodule:: evennia.commands.default.help + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.muxcommand.rst b/docs/source/api/evennia.commands.default.muxcommand.rst new file mode 100644 index 0000000000..f47330d5cf --- /dev/null +++ b/docs/source/api/evennia.commands.default.muxcommand.rst @@ -0,0 +1,7 @@ +evennia.commands.default.muxcommand +========================================== + +.. automodule:: evennia.commands.default.muxcommand + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.rst b/docs/source/api/evennia.commands.default.rst index 93224311b7..733185d49d 100644 --- a/docs/source/api/evennia.commands.default.rst +++ b/docs/source/api/evennia.commands.default.rst @@ -1,4 +1,4 @@ -evennia.commands.default package +evennia.commands.default ================================ .. automodule:: evennia.commands.default @@ -9,131 +9,22 @@ evennia.commands.default package Submodules ---------- -evennia.commands.default.account module ---------------------------------------- - -.. automodule:: evennia.commands.default.account - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.admin module -------------------------------------- - -.. automodule:: evennia.commands.default.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.batchprocess module --------------------------------------------- - -.. automodule:: evennia.commands.default.batchprocess - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.building module ----------------------------------------- - -.. automodule:: evennia.commands.default.building - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.cmdset\_account module ------------------------------------------------ - -.. automodule:: evennia.commands.default.cmdset_account - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.cmdset\_character module -------------------------------------------------- - -.. automodule:: evennia.commands.default.cmdset_character - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.cmdset\_session module ------------------------------------------------ - -.. automodule:: evennia.commands.default.cmdset_session - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.cmdset\_unloggedin module --------------------------------------------------- - -.. automodule:: evennia.commands.default.cmdset_unloggedin - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.comms module -------------------------------------- - -.. automodule:: evennia.commands.default.comms - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.general module ---------------------------------------- - -.. automodule:: evennia.commands.default.general - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.help module ------------------------------------- - -.. automodule:: evennia.commands.default.help - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.muxcommand module ------------------------------------------- - -.. automodule:: evennia.commands.default.muxcommand - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.syscommands module -------------------------------------------- - -.. automodule:: evennia.commands.default.syscommands - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.system module --------------------------------------- - -.. automodule:: evennia.commands.default.system - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.tests module -------------------------------------- - -.. automodule:: evennia.commands.default.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.default.unloggedin module ------------------------------------------- - -.. automodule:: evennia.commands.default.unloggedin - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.commands.default.account + evennia.commands.default.admin + evennia.commands.default.batchprocess + evennia.commands.default.building + evennia.commands.default.cmdset_account + evennia.commands.default.cmdset_character + evennia.commands.default.cmdset_session + evennia.commands.default.cmdset_unloggedin + evennia.commands.default.comms + evennia.commands.default.general + evennia.commands.default.help + evennia.commands.default.muxcommand + evennia.commands.default.syscommands + evennia.commands.default.system + evennia.commands.default.tests + evennia.commands.default.unloggedin diff --git a/docs/source/api/evennia.commands.default.syscommands.rst b/docs/source/api/evennia.commands.default.syscommands.rst new file mode 100644 index 0000000000..630b2c79c9 --- /dev/null +++ b/docs/source/api/evennia.commands.default.syscommands.rst @@ -0,0 +1,7 @@ +evennia.commands.default.syscommands +=========================================== + +.. automodule:: evennia.commands.default.syscommands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.system.rst b/docs/source/api/evennia.commands.default.system.rst new file mode 100644 index 0000000000..0a17a98249 --- /dev/null +++ b/docs/source/api/evennia.commands.default.system.rst @@ -0,0 +1,7 @@ +evennia.commands.default.system +====================================== + +.. automodule:: evennia.commands.default.system + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.tests.rst b/docs/source/api/evennia.commands.default.tests.rst new file mode 100644 index 0000000000..ee49a77bef --- /dev/null +++ b/docs/source/api/evennia.commands.default.tests.rst @@ -0,0 +1,7 @@ +evennia.commands.default.tests +===================================== + +.. automodule:: evennia.commands.default.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.default.unloggedin.rst b/docs/source/api/evennia.commands.default.unloggedin.rst new file mode 100644 index 0000000000..87ccf8cbce --- /dev/null +++ b/docs/source/api/evennia.commands.default.unloggedin.rst @@ -0,0 +1,7 @@ +evennia.commands.default.unloggedin +========================================== + +.. automodule:: evennia.commands.default.unloggedin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.commands.rst b/docs/source/api/evennia.commands.rst index d78291eb89..9d2088cd48 100644 --- a/docs/source/api/evennia.commands.rst +++ b/docs/source/api/evennia.commands.rst @@ -1,4 +1,4 @@ -evennia.commands package +evennia.commands ======================== .. automodule:: evennia.commands @@ -10,57 +10,19 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.commands.default Submodules ---------- -evennia.commands.cmdhandler module ----------------------------------- - -.. automodule:: evennia.commands.cmdhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.cmdparser module ---------------------------------- - -.. automodule:: evennia.commands.cmdparser - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.cmdset module ------------------------------- - -.. automodule:: evennia.commands.cmdset - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.cmdsethandler module -------------------------------------- - -.. automodule:: evennia.commands.cmdsethandler - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.command module -------------------------------- - -.. automodule:: evennia.commands.command - :members: - :undoc-members: - :show-inheritance: - -evennia.commands.tests module ------------------------------ - -.. automodule:: evennia.commands.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.commands.cmdhandler + evennia.commands.cmdparser + evennia.commands.cmdset + evennia.commands.cmdsethandler + evennia.commands.command + evennia.commands.tests diff --git a/docs/source/api/evennia.commands.tests.rst b/docs/source/api/evennia.commands.tests.rst new file mode 100644 index 0000000000..af5f164c8f --- /dev/null +++ b/docs/source/api/evennia.commands.tests.rst @@ -0,0 +1,7 @@ +evennia.commands.tests +============================= + +.. automodule:: evennia.commands.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.admin.rst b/docs/source/api/evennia.comms.admin.rst new file mode 100644 index 0000000000..c80ae8d993 --- /dev/null +++ b/docs/source/api/evennia.comms.admin.rst @@ -0,0 +1,7 @@ +evennia.comms.admin +========================== + +.. automodule:: evennia.comms.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.channelhandler.rst b/docs/source/api/evennia.comms.channelhandler.rst new file mode 100644 index 0000000000..0d0561cef3 --- /dev/null +++ b/docs/source/api/evennia.comms.channelhandler.rst @@ -0,0 +1,7 @@ +evennia.comms.channelhandler +=================================== + +.. automodule:: evennia.comms.channelhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.comms.rst b/docs/source/api/evennia.comms.comms.rst new file mode 100644 index 0000000000..0d137a7f0e --- /dev/null +++ b/docs/source/api/evennia.comms.comms.rst @@ -0,0 +1,7 @@ +evennia.comms.comms +========================== + +.. automodule:: evennia.comms.comms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.managers.rst b/docs/source/api/evennia.comms.managers.rst new file mode 100644 index 0000000000..32c444ac3f --- /dev/null +++ b/docs/source/api/evennia.comms.managers.rst @@ -0,0 +1,7 @@ +evennia.comms.managers +============================= + +.. automodule:: evennia.comms.managers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.migrations.rst b/docs/source/api/evennia.comms.migrations.rst deleted file mode 100644 index 40b39fb0d5..0000000000 --- a/docs/source/api/evennia.comms.migrations.rst +++ /dev/null @@ -1,163 +0,0 @@ -evennia.comms.migrations package -================================ - -.. automodule:: evennia.comms.migrations - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.comms.migrations.0001\_initial module ---------------------------------------------- - -.. automodule:: evennia.comms.migrations.0001_initial - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0002\_msg\_db\_hide\_from\_objects module ------------------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0002_msg_db_hide_from_objects - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0003\_auto\_20140917\_0756 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0003_auto_20140917_0756 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0004\_auto\_20150118\_1631 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0004_auto_20150118_1631 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0005\_auto\_20150223\_1517 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0005_auto_20150223_1517 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0006\_channeldb\_db\_object\_subscriptions module --------------------------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0006_channeldb_db_object_subscriptions - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0007\_msg\_db\_tags module ---------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0007_msg_db_tags - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0008\_auto\_20160905\_0902 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0008_auto_20160905_0902 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0009\_auto\_20160921\_1731 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0009_auto_20160921_1731 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0010\_auto\_20161206\_1912 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0010_auto_20161206_1912 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0011\_auto\_20170217\_2039 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0011_auto_20170217_2039 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0011\_auto\_20170606\_1731 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0011_auto_20170606_1731 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0012\_merge\_20170617\_2017 module ------------------------------------------------------------ - -.. automodule:: evennia.comms.migrations.0012_merge_20170617_2017 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0013\_auto\_20170705\_1726 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0013_auto_20170705_1726 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0014\_auto\_20170705\_1736 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0014_auto_20170705_1736 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0015\_auto\_20170706\_2041 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0015_auto_20170706_2041 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0016\_auto\_20180925\_1735 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0016_auto_20180925_1735 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0017\_auto\_20190128\_1820 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0017_auto_20190128_1820 - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.migrations.0018\_auto\_20191025\_0831 module ----------------------------------------------------------- - -.. automodule:: evennia.comms.migrations.0018_auto_20191025_0831 - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.comms.models.rst b/docs/source/api/evennia.comms.models.rst new file mode 100644 index 0000000000..502abf6077 --- /dev/null +++ b/docs/source/api/evennia.comms.models.rst @@ -0,0 +1,7 @@ +evennia.comms.models +=========================== + +.. automodule:: evennia.comms.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.comms.rst b/docs/source/api/evennia.comms.rst index fbcf33000f..378befb756 100644 --- a/docs/source/api/evennia.comms.rst +++ b/docs/source/api/evennia.comms.rst @@ -1,4 +1,4 @@ -evennia.comms package +evennia.comms ===================== .. automodule:: evennia.comms @@ -6,61 +6,15 @@ evennia.comms package :undoc-members: :show-inheritance: -Subpackages ------------ - -.. toctree:: - - evennia.comms.migrations - Submodules ---------- -evennia.comms.admin module --------------------------- - -.. automodule:: evennia.comms.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.channelhandler module ------------------------------------ - -.. automodule:: evennia.comms.channelhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.comms module --------------------------- - -.. automodule:: evennia.comms.comms - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.managers module ------------------------------ - -.. automodule:: evennia.comms.managers - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.models module ---------------------------- - -.. automodule:: evennia.comms.models - :members: - :undoc-members: - :show-inheritance: - -evennia.comms.tests module --------------------------- - -.. automodule:: evennia.comms.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.comms.admin + evennia.comms.channelhandler + evennia.comms.comms + evennia.comms.managers + evennia.comms.models + evennia.comms.tests diff --git a/docs/source/api/evennia.comms.tests.rst b/docs/source/api/evennia.comms.tests.rst new file mode 100644 index 0000000000..dcc9d1d061 --- /dev/null +++ b/docs/source/api/evennia.comms.tests.rst @@ -0,0 +1,7 @@ +evennia.comms.tests +========================== + +.. automodule:: evennia.comms.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.awsstorage.aws_s3_cdn.rst b/docs/source/api/evennia.contrib.awsstorage.aws_s3_cdn.rst new file mode 100644 index 0000000000..d8459814bd --- /dev/null +++ b/docs/source/api/evennia.contrib.awsstorage.aws_s3_cdn.rst @@ -0,0 +1,7 @@ +evennia.contrib.awsstorage.aws\_s3\_cdn +============================================== + +.. automodule:: evennia.contrib.awsstorage.aws_s3_cdn + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.awsstorage.rst b/docs/source/api/evennia.contrib.awsstorage.rst index 864d562817..2ae52ee845 100644 --- a/docs/source/api/evennia.contrib.awsstorage.rst +++ b/docs/source/api/evennia.contrib.awsstorage.rst @@ -1,4 +1,4 @@ -evennia.contrib.awsstorage package +evennia.contrib.awsstorage ================================== .. automodule:: evennia.contrib.awsstorage @@ -9,19 +9,8 @@ evennia.contrib.awsstorage package Submodules ---------- -evennia.contrib.awsstorage.aws\_s3\_cdn module ----------------------------------------------- - -.. automodule:: evennia.contrib.awsstorage.aws_s3_cdn - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.awsstorage.tests module ---------------------------------------- - -.. automodule:: evennia.contrib.awsstorage.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.contrib.awsstorage.aws_s3_cdn + evennia.contrib.awsstorage.tests diff --git a/docs/source/api/evennia.contrib.awsstorage.tests.rst b/docs/source/api/evennia.contrib.awsstorage.tests.rst new file mode 100644 index 0000000000..2c6b839c33 --- /dev/null +++ b/docs/source/api/evennia.contrib.awsstorage.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.awsstorage.tests +======================================= + +.. automodule:: evennia.contrib.awsstorage.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.barter.rst b/docs/source/api/evennia.contrib.barter.rst new file mode 100644 index 0000000000..d9310e1c04 --- /dev/null +++ b/docs/source/api/evennia.contrib.barter.rst @@ -0,0 +1,7 @@ +evennia.contrib.barter +============================= + +.. automodule:: evennia.contrib.barter + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.building_menu.rst b/docs/source/api/evennia.contrib.building_menu.rst new file mode 100644 index 0000000000..48311502d9 --- /dev/null +++ b/docs/source/api/evennia.contrib.building_menu.rst @@ -0,0 +1,7 @@ +evennia.contrib.building\_menu +===================================== + +.. automodule:: evennia.contrib.building_menu + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.chargen.rst b/docs/source/api/evennia.contrib.chargen.rst new file mode 100644 index 0000000000..2798f01af2 --- /dev/null +++ b/docs/source/api/evennia.contrib.chargen.rst @@ -0,0 +1,7 @@ +evennia.contrib.chargen +============================== + +.. automodule:: evennia.contrib.chargen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.clothing.rst b/docs/source/api/evennia.contrib.clothing.rst new file mode 100644 index 0000000000..294a5bbfe8 --- /dev/null +++ b/docs/source/api/evennia.contrib.clothing.rst @@ -0,0 +1,7 @@ +evennia.contrib.clothing +=============================== + +.. automodule:: evennia.contrib.clothing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.color_markups.rst b/docs/source/api/evennia.contrib.color_markups.rst new file mode 100644 index 0000000000..af0f20555d --- /dev/null +++ b/docs/source/api/evennia.contrib.color_markups.rst @@ -0,0 +1,7 @@ +evennia.contrib.color\_markups +===================================== + +.. automodule:: evennia.contrib.color_markups + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.custom_gametime.rst b/docs/source/api/evennia.contrib.custom_gametime.rst new file mode 100644 index 0000000000..b0e88bf61f --- /dev/null +++ b/docs/source/api/evennia.contrib.custom_gametime.rst @@ -0,0 +1,7 @@ +evennia.contrib.custom\_gametime +======================================= + +.. automodule:: evennia.contrib.custom_gametime + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.dice.rst b/docs/source/api/evennia.contrib.dice.rst new file mode 100644 index 0000000000..dffa191433 --- /dev/null +++ b/docs/source/api/evennia.contrib.dice.rst @@ -0,0 +1,7 @@ +evennia.contrib.dice +=========================== + +.. automodule:: evennia.contrib.dice + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.email_login.rst b/docs/source/api/evennia.contrib.email_login.rst new file mode 100644 index 0000000000..7b93c80e84 --- /dev/null +++ b/docs/source/api/evennia.contrib.email_login.rst @@ -0,0 +1,7 @@ +evennia.contrib.email\_login +=================================== + +.. automodule:: evennia.contrib.email_login + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.extended_room.rst b/docs/source/api/evennia.contrib.extended_room.rst new file mode 100644 index 0000000000..0a42631a15 --- /dev/null +++ b/docs/source/api/evennia.contrib.extended_room.rst @@ -0,0 +1,7 @@ +evennia.contrib.extended\_room +===================================== + +.. automodule:: evennia.contrib.extended_room + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.fieldfill.rst b/docs/source/api/evennia.contrib.fieldfill.rst new file mode 100644 index 0000000000..9444e16f70 --- /dev/null +++ b/docs/source/api/evennia.contrib.fieldfill.rst @@ -0,0 +1,7 @@ +evennia.contrib.fieldfill +================================ + +.. automodule:: evennia.contrib.fieldfill + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.gendersub.rst b/docs/source/api/evennia.contrib.gendersub.rst new file mode 100644 index 0000000000..fbc19b68d1 --- /dev/null +++ b/docs/source/api/evennia.contrib.gendersub.rst @@ -0,0 +1,7 @@ +evennia.contrib.gendersub +================================ + +.. automodule:: evennia.contrib.gendersub + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.health_bar.rst b/docs/source/api/evennia.contrib.health_bar.rst new file mode 100644 index 0000000000..af113dc131 --- /dev/null +++ b/docs/source/api/evennia.contrib.health_bar.rst @@ -0,0 +1,7 @@ +evennia.contrib.health\_bar +================================== + +.. automodule:: evennia.contrib.health_bar + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.ingame_python.callbackhandler.rst b/docs/source/api/evennia.contrib.ingame_python.callbackhandler.rst new file mode 100644 index 0000000000..d35d74a8b2 --- /dev/null +++ b/docs/source/api/evennia.contrib.ingame_python.callbackhandler.rst @@ -0,0 +1,7 @@ +evennia.contrib.ingame\_python.callbackhandler +===================================================== + +.. automodule:: evennia.contrib.ingame_python.callbackhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.ingame_python.commands.rst b/docs/source/api/evennia.contrib.ingame_python.commands.rst new file mode 100644 index 0000000000..04461dd95d --- /dev/null +++ b/docs/source/api/evennia.contrib.ingame_python.commands.rst @@ -0,0 +1,7 @@ +evennia.contrib.ingame\_python.commands +============================================== + +.. automodule:: evennia.contrib.ingame_python.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.ingame_python.eventfuncs.rst b/docs/source/api/evennia.contrib.ingame_python.eventfuncs.rst new file mode 100644 index 0000000000..1c534da396 --- /dev/null +++ b/docs/source/api/evennia.contrib.ingame_python.eventfuncs.rst @@ -0,0 +1,7 @@ +evennia.contrib.ingame\_python.eventfuncs +================================================ + +.. automodule:: evennia.contrib.ingame_python.eventfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.ingame_python.rst b/docs/source/api/evennia.contrib.ingame_python.rst index eb68f70336..80f5bbe925 100644 --- a/docs/source/api/evennia.contrib.ingame_python.rst +++ b/docs/source/api/evennia.contrib.ingame_python.rst @@ -1,4 +1,4 @@ -evennia.contrib.ingame\_python package +evennia.contrib.ingame\_python ====================================== .. automodule:: evennia.contrib.ingame_python @@ -9,59 +9,13 @@ evennia.contrib.ingame\_python package Submodules ---------- -evennia.contrib.ingame\_python.callbackhandler module ------------------------------------------------------ - -.. automodule:: evennia.contrib.ingame_python.callbackhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.ingame\_python.commands module ----------------------------------------------- - -.. automodule:: evennia.contrib.ingame_python.commands - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.ingame\_python.eventfuncs module ------------------------------------------------- - -.. automodule:: evennia.contrib.ingame_python.eventfuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.ingame\_python.scripts module ---------------------------------------------- - -.. automodule:: evennia.contrib.ingame_python.scripts - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.ingame\_python.tests module -------------------------------------------- - -.. automodule:: evennia.contrib.ingame_python.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.ingame\_python.typeclasses module -------------------------------------------------- - -.. automodule:: evennia.contrib.ingame_python.typeclasses - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.ingame\_python.utils module -------------------------------------------- - -.. automodule:: evennia.contrib.ingame_python.utils - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.contrib.ingame_python.callbackhandler + evennia.contrib.ingame_python.commands + evennia.contrib.ingame_python.eventfuncs + evennia.contrib.ingame_python.scripts + evennia.contrib.ingame_python.tests + evennia.contrib.ingame_python.typeclasses + evennia.contrib.ingame_python.utils diff --git a/docs/source/api/evennia.contrib.ingame_python.scripts.rst b/docs/source/api/evennia.contrib.ingame_python.scripts.rst new file mode 100644 index 0000000000..e10d643df5 --- /dev/null +++ b/docs/source/api/evennia.contrib.ingame_python.scripts.rst @@ -0,0 +1,7 @@ +evennia.contrib.ingame\_python.scripts +============================================= + +.. automodule:: evennia.contrib.ingame_python.scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.ingame_python.tests.rst b/docs/source/api/evennia.contrib.ingame_python.tests.rst new file mode 100644 index 0000000000..de2edcf047 --- /dev/null +++ b/docs/source/api/evennia.contrib.ingame_python.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.ingame\_python.tests +=========================================== + +.. automodule:: evennia.contrib.ingame_python.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.ingame_python.typeclasses.rst b/docs/source/api/evennia.contrib.ingame_python.typeclasses.rst new file mode 100644 index 0000000000..fdd43475de --- /dev/null +++ b/docs/source/api/evennia.contrib.ingame_python.typeclasses.rst @@ -0,0 +1,7 @@ +evennia.contrib.ingame\_python.typeclasses +================================================= + +.. automodule:: evennia.contrib.ingame_python.typeclasses + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.ingame_python.utils.rst b/docs/source/api/evennia.contrib.ingame_python.utils.rst new file mode 100644 index 0000000000..aefcdd3bc5 --- /dev/null +++ b/docs/source/api/evennia.contrib.ingame_python.utils.rst @@ -0,0 +1,7 @@ +evennia.contrib.ingame\_python.utils +=========================================== + +.. automodule:: evennia.contrib.ingame_python.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.mail.rst b/docs/source/api/evennia.contrib.mail.rst new file mode 100644 index 0000000000..d0999aeb18 --- /dev/null +++ b/docs/source/api/evennia.contrib.mail.rst @@ -0,0 +1,7 @@ +evennia.contrib.mail +=========================== + +.. automodule:: evennia.contrib.mail + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.mapbuilder.rst b/docs/source/api/evennia.contrib.mapbuilder.rst new file mode 100644 index 0000000000..6353d674a2 --- /dev/null +++ b/docs/source/api/evennia.contrib.mapbuilder.rst @@ -0,0 +1,7 @@ +evennia.contrib.mapbuilder +================================= + +.. automodule:: evennia.contrib.mapbuilder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.menu_login.rst b/docs/source/api/evennia.contrib.menu_login.rst new file mode 100644 index 0000000000..72dd5f21cd --- /dev/null +++ b/docs/source/api/evennia.contrib.menu_login.rst @@ -0,0 +1,7 @@ +evennia.contrib.menu\_login +================================== + +.. automodule:: evennia.contrib.menu_login + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.multidescer.rst b/docs/source/api/evennia.contrib.multidescer.rst new file mode 100644 index 0000000000..2e208b96c9 --- /dev/null +++ b/docs/source/api/evennia.contrib.multidescer.rst @@ -0,0 +1,7 @@ +evennia.contrib.multidescer +================================== + +.. automodule:: evennia.contrib.multidescer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.puzzles.rst b/docs/source/api/evennia.contrib.puzzles.rst new file mode 100644 index 0000000000..709ab98bb9 --- /dev/null +++ b/docs/source/api/evennia.contrib.puzzles.rst @@ -0,0 +1,7 @@ +evennia.contrib.puzzles +============================== + +.. automodule:: evennia.contrib.puzzles + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.random_string_generator.rst b/docs/source/api/evennia.contrib.random_string_generator.rst new file mode 100644 index 0000000000..e03fc819a3 --- /dev/null +++ b/docs/source/api/evennia.contrib.random_string_generator.rst @@ -0,0 +1,7 @@ +evennia.contrib.random\_string\_generator +================================================ + +.. automodule:: evennia.contrib.random_string_generator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rplanguage.rst b/docs/source/api/evennia.contrib.rplanguage.rst new file mode 100644 index 0000000000..b3b4c96135 --- /dev/null +++ b/docs/source/api/evennia.contrib.rplanguage.rst @@ -0,0 +1,7 @@ +evennia.contrib.rplanguage +================================= + +.. automodule:: evennia.contrib.rplanguage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rpsystem.rst b/docs/source/api/evennia.contrib.rpsystem.rst new file mode 100644 index 0000000000..0909f232b5 --- /dev/null +++ b/docs/source/api/evennia.contrib.rpsystem.rst @@ -0,0 +1,7 @@ +evennia.contrib.rpsystem +=============================== + +.. automodule:: evennia.contrib.rpsystem + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.rst b/docs/source/api/evennia.contrib.rst index c2dbd1f9fd..1f88841536 100644 --- a/docs/source/api/evennia.contrib.rst +++ b/docs/source/api/evennia.contrib.rst @@ -1,4 +1,4 @@ -evennia.contrib package +evennia.contrib ======================= .. automodule:: evennia.contrib @@ -10,6 +10,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.contrib.awsstorage evennia.contrib.ingame_python @@ -21,235 +22,35 @@ Subpackages Submodules ---------- -evennia.contrib.barter module ------------------------------ - -.. automodule:: evennia.contrib.barter - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.building\_menu module -------------------------------------- - -.. automodule:: evennia.contrib.building_menu - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.chargen module ------------------------------- - -.. automodule:: evennia.contrib.chargen - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.clothing module -------------------------------- - -.. automodule:: evennia.contrib.clothing - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.color\_markups module -------------------------------------- - -.. automodule:: evennia.contrib.color_markups - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.custom\_gametime module ---------------------------------------- - -.. automodule:: evennia.contrib.custom_gametime - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.dice module ---------------------------- - -.. automodule:: evennia.contrib.dice - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.email\_login module ------------------------------------ - -.. automodule:: evennia.contrib.email_login - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.extended\_room module -------------------------------------- - -.. automodule:: evennia.contrib.extended_room - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.fieldfill module --------------------------------- - -.. automodule:: evennia.contrib.fieldfill - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.gendersub module --------------------------------- - -.. automodule:: evennia.contrib.gendersub - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.health\_bar module ----------------------------------- - -.. automodule:: evennia.contrib.health_bar - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.mail module ---------------------------- - -.. automodule:: evennia.contrib.mail - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.mapbuilder module ---------------------------------- - -.. automodule:: evennia.contrib.mapbuilder - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.menu\_login module ----------------------------------- - -.. automodule:: evennia.contrib.menu_login - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.multidescer module ----------------------------------- - -.. automodule:: evennia.contrib.multidescer - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.puzzles module ------------------------------- - -.. automodule:: evennia.contrib.puzzles - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.random\_string\_generator module ------------------------------------------------- - -.. automodule:: evennia.contrib.random_string_generator - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.rplanguage module ---------------------------------- - -.. automodule:: evennia.contrib.rplanguage - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.rpsystem module -------------------------------- - -.. automodule:: evennia.contrib.rpsystem - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.simpledoor module ---------------------------------- - -.. automodule:: evennia.contrib.simpledoor - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.slow\_exit module ---------------------------------- - -.. automodule:: evennia.contrib.slow_exit - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.talking\_npc module ------------------------------------ - -.. automodule:: evennia.contrib.talking_npc - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.test\_traits module ------------------------------------ - -.. automodule:: evennia.contrib.test_traits - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tests module ----------------------------- - -.. automodule:: evennia.contrib.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.traits module ------------------------------ - -.. automodule:: evennia.contrib.traits - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tree\_select module ------------------------------------ - -.. automodule:: evennia.contrib.tree_select - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.unixcommand module ----------------------------------- - -.. automodule:: evennia.contrib.unixcommand - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.wilderness module ---------------------------------- - -.. automodule:: evennia.contrib.wilderness - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.contrib.barter + evennia.contrib.building_menu + evennia.contrib.chargen + evennia.contrib.clothing + evennia.contrib.color_markups + evennia.contrib.custom_gametime + evennia.contrib.dice + evennia.contrib.email_login + evennia.contrib.extended_room + evennia.contrib.fieldfill + evennia.contrib.gendersub + evennia.contrib.health_bar + evennia.contrib.mail + evennia.contrib.mapbuilder + evennia.contrib.menu_login + evennia.contrib.multidescer + evennia.contrib.puzzles + evennia.contrib.random_string_generator + evennia.contrib.rplanguage + evennia.contrib.rpsystem + evennia.contrib.simpledoor + evennia.contrib.slow_exit + evennia.contrib.talking_npc + evennia.contrib.test_traits + evennia.contrib.tests + evennia.contrib.traits + evennia.contrib.tree_select + evennia.contrib.unixcommand + evennia.contrib.wilderness diff --git a/docs/source/api/evennia.contrib.security.auditing.outputs.rst b/docs/source/api/evennia.contrib.security.auditing.outputs.rst new file mode 100644 index 0000000000..3f00916652 --- /dev/null +++ b/docs/source/api/evennia.contrib.security.auditing.outputs.rst @@ -0,0 +1,7 @@ +evennia.contrib.security.auditing.outputs +================================================ + +.. automodule:: evennia.contrib.security.auditing.outputs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.security.auditing.rst b/docs/source/api/evennia.contrib.security.auditing.rst index 6f77fed3f3..b9d1fc13ca 100644 --- a/docs/source/api/evennia.contrib.security.auditing.rst +++ b/docs/source/api/evennia.contrib.security.auditing.rst @@ -1,4 +1,4 @@ -evennia.contrib.security.auditing package +evennia.contrib.security.auditing ========================================= .. automodule:: evennia.contrib.security.auditing @@ -9,27 +9,9 @@ evennia.contrib.security.auditing package Submodules ---------- -evennia.contrib.security.auditing.outputs module ------------------------------------------------- - -.. automodule:: evennia.contrib.security.auditing.outputs - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.security.auditing.server module ------------------------------------------------ - -.. automodule:: evennia.contrib.security.auditing.server - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.security.auditing.tests module ----------------------------------------------- - -.. automodule:: evennia.contrib.security.auditing.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.contrib.security.auditing.outputs + evennia.contrib.security.auditing.server + evennia.contrib.security.auditing.tests diff --git a/docs/source/api/evennia.contrib.security.auditing.server.rst b/docs/source/api/evennia.contrib.security.auditing.server.rst new file mode 100644 index 0000000000..0f3969d39a --- /dev/null +++ b/docs/source/api/evennia.contrib.security.auditing.server.rst @@ -0,0 +1,7 @@ +evennia.contrib.security.auditing.server +=============================================== + +.. automodule:: evennia.contrib.security.auditing.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.security.auditing.tests.rst b/docs/source/api/evennia.contrib.security.auditing.tests.rst new file mode 100644 index 0000000000..5daead6967 --- /dev/null +++ b/docs/source/api/evennia.contrib.security.auditing.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.security.auditing.tests +============================================== + +.. automodule:: evennia.contrib.security.auditing.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.security.rst b/docs/source/api/evennia.contrib.security.rst index 32170666cb..431329fcf2 100644 --- a/docs/source/api/evennia.contrib.security.rst +++ b/docs/source/api/evennia.contrib.security.rst @@ -1,4 +1,4 @@ -evennia.contrib.security package +evennia.contrib.security ================================ .. automodule:: evennia.contrib.security @@ -10,5 +10,6 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.contrib.security.auditing diff --git a/docs/source/api/evennia.contrib.simpledoor.rst b/docs/source/api/evennia.contrib.simpledoor.rst new file mode 100644 index 0000000000..3d6921be0c --- /dev/null +++ b/docs/source/api/evennia.contrib.simpledoor.rst @@ -0,0 +1,7 @@ +evennia.contrib.simpledoor +================================= + +.. automodule:: evennia.contrib.simpledoor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.slow_exit.rst b/docs/source/api/evennia.contrib.slow_exit.rst new file mode 100644 index 0000000000..497e45659d --- /dev/null +++ b/docs/source/api/evennia.contrib.slow_exit.rst @@ -0,0 +1,7 @@ +evennia.contrib.slow\_exit +================================= + +.. automodule:: evennia.contrib.slow_exit + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.talking_npc.rst b/docs/source/api/evennia.contrib.talking_npc.rst new file mode 100644 index 0000000000..cd652e66b5 --- /dev/null +++ b/docs/source/api/evennia.contrib.talking_npc.rst @@ -0,0 +1,7 @@ +evennia.contrib.talking\_npc +=================================== + +.. automodule:: evennia.contrib.talking_npc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.test_traits.rst b/docs/source/api/evennia.contrib.test_traits.rst new file mode 100644 index 0000000000..a031821cba --- /dev/null +++ b/docs/source/api/evennia.contrib.test_traits.rst @@ -0,0 +1,7 @@ +evennia.contrib.test\_traits +=================================== + +.. automodule:: evennia.contrib.test_traits + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tests.rst b/docs/source/api/evennia.contrib.tests.rst new file mode 100644 index 0000000000..5fb97fd250 --- /dev/null +++ b/docs/source/api/evennia.contrib.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.tests +============================ + +.. automodule:: evennia.contrib.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.traits.rst b/docs/source/api/evennia.contrib.traits.rst new file mode 100644 index 0000000000..95b3693819 --- /dev/null +++ b/docs/source/api/evennia.contrib.traits.rst @@ -0,0 +1,7 @@ +evennia.contrib.traits +============================= + +.. automodule:: evennia.contrib.traits + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tree_select.rst b/docs/source/api/evennia.contrib.tree_select.rst new file mode 100644 index 0000000000..887cdff507 --- /dev/null +++ b/docs/source/api/evennia.contrib.tree_select.rst @@ -0,0 +1,7 @@ +evennia.contrib.tree\_select +=================================== + +.. automodule:: evennia.contrib.tree_select + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.turnbattle.rst b/docs/source/api/evennia.contrib.turnbattle.rst index 21e2959483..7384b3ab7c 100644 --- a/docs/source/api/evennia.contrib.turnbattle.rst +++ b/docs/source/api/evennia.contrib.turnbattle.rst @@ -1,4 +1,4 @@ -evennia.contrib.turnbattle package +evennia.contrib.turnbattle ================================== .. automodule:: evennia.contrib.turnbattle @@ -9,43 +9,11 @@ evennia.contrib.turnbattle package Submodules ---------- -evennia.contrib.turnbattle.tb\_basic module -------------------------------------------- - -.. automodule:: evennia.contrib.turnbattle.tb_basic - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.turnbattle.tb\_equip module -------------------------------------------- - -.. automodule:: evennia.contrib.turnbattle.tb_equip - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.turnbattle.tb\_items module -------------------------------------------- - -.. automodule:: evennia.contrib.turnbattle.tb_items - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.turnbattle.tb\_magic module -------------------------------------------- - -.. automodule:: evennia.contrib.turnbattle.tb_magic - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.turnbattle.tb\_range module -------------------------------------------- - -.. automodule:: evennia.contrib.turnbattle.tb_range - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.contrib.turnbattle.tb_basic + evennia.contrib.turnbattle.tb_equip + evennia.contrib.turnbattle.tb_items + evennia.contrib.turnbattle.tb_magic + evennia.contrib.turnbattle.tb_range diff --git a/docs/source/api/evennia.contrib.turnbattle.tb_basic.rst b/docs/source/api/evennia.contrib.turnbattle.tb_basic.rst new file mode 100644 index 0000000000..47e51a9813 --- /dev/null +++ b/docs/source/api/evennia.contrib.turnbattle.tb_basic.rst @@ -0,0 +1,7 @@ +evennia.contrib.turnbattle.tb\_basic +=========================================== + +.. automodule:: evennia.contrib.turnbattle.tb_basic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.turnbattle.tb_equip.rst b/docs/source/api/evennia.contrib.turnbattle.tb_equip.rst new file mode 100644 index 0000000000..7413f0f5a8 --- /dev/null +++ b/docs/source/api/evennia.contrib.turnbattle.tb_equip.rst @@ -0,0 +1,7 @@ +evennia.contrib.turnbattle.tb\_equip +=========================================== + +.. automodule:: evennia.contrib.turnbattle.tb_equip + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.turnbattle.tb_items.rst b/docs/source/api/evennia.contrib.turnbattle.tb_items.rst new file mode 100644 index 0000000000..8e3b47452a --- /dev/null +++ b/docs/source/api/evennia.contrib.turnbattle.tb_items.rst @@ -0,0 +1,7 @@ +evennia.contrib.turnbattle.tb\_items +=========================================== + +.. automodule:: evennia.contrib.turnbattle.tb_items + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.turnbattle.tb_magic.rst b/docs/source/api/evennia.contrib.turnbattle.tb_magic.rst new file mode 100644 index 0000000000..8b22a80979 --- /dev/null +++ b/docs/source/api/evennia.contrib.turnbattle.tb_magic.rst @@ -0,0 +1,7 @@ +evennia.contrib.turnbattle.tb\_magic +=========================================== + +.. automodule:: evennia.contrib.turnbattle.tb_magic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.turnbattle.tb_range.rst b/docs/source/api/evennia.contrib.turnbattle.tb_range.rst new file mode 100644 index 0000000000..604e6f6dd3 --- /dev/null +++ b/docs/source/api/evennia.contrib.turnbattle.tb_range.rst @@ -0,0 +1,7 @@ +evennia.contrib.turnbattle.tb\_range +=========================================== + +.. automodule:: evennia.contrib.turnbattle.tb_range + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_examples.bodyfunctions.rst b/docs/source/api/evennia.contrib.tutorial_examples.bodyfunctions.rst new file mode 100644 index 0000000000..22ba12c821 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_examples.bodyfunctions.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_examples.bodyfunctions +======================================================= + +.. automodule:: evennia.contrib.tutorial_examples.bodyfunctions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_examples.cmdset_red_button.rst b/docs/source/api/evennia.contrib.tutorial_examples.cmdset_red_button.rst new file mode 100644 index 0000000000..4686f928d2 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_examples.cmdset_red_button.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_examples.cmdset\_red\_button +============================================================= + +.. automodule:: evennia.contrib.tutorial_examples.cmdset_red_button + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_examples.example_batch_code.rst b/docs/source/api/evennia.contrib.tutorial_examples.example_batch_code.rst new file mode 100644 index 0000000000..606cf5d236 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_examples.example_batch_code.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_examples.example\_batch\_code +============================================================== + +.. automodule:: evennia.contrib.tutorial_examples.example_batch_code + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_examples.red_button.rst b/docs/source/api/evennia.contrib.tutorial_examples.red_button.rst new file mode 100644 index 0000000000..076b68b44f --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_examples.red_button.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_examples.red\_button +===================================================== + +.. automodule:: evennia.contrib.tutorial_examples.red_button + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_examples.red_button_scripts.rst b/docs/source/api/evennia.contrib.tutorial_examples.red_button_scripts.rst new file mode 100644 index 0000000000..157747b84e --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_examples.red_button_scripts.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_examples.red\_button\_scripts +============================================================== + +.. automodule:: evennia.contrib.tutorial_examples.red_button_scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_examples.rst b/docs/source/api/evennia.contrib.tutorial_examples.rst index 8730deea98..8ae294a31d 100644 --- a/docs/source/api/evennia.contrib.tutorial_examples.rst +++ b/docs/source/api/evennia.contrib.tutorial_examples.rst @@ -1,4 +1,4 @@ -evennia.contrib.tutorial\_examples package +evennia.contrib.tutorial\_examples ========================================== .. automodule:: evennia.contrib.tutorial_examples @@ -9,51 +9,12 @@ evennia.contrib.tutorial\_examples package Submodules ---------- -evennia.contrib.tutorial\_examples.bodyfunctions module -------------------------------------------------------- - -.. automodule:: evennia.contrib.tutorial_examples.bodyfunctions - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tutorial\_examples.cmdset\_red\_button module -------------------------------------------------------------- - -.. automodule:: evennia.contrib.tutorial_examples.cmdset_red_button - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tutorial\_examples.example\_batch\_code module --------------------------------------------------------------- - -.. automodule:: evennia.contrib.tutorial_examples.example_batch_code - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tutorial\_examples.red\_button module ------------------------------------------------------ - -.. automodule:: evennia.contrib.tutorial_examples.red_button - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tutorial\_examples.red\_button\_scripts module --------------------------------------------------------------- - -.. automodule:: evennia.contrib.tutorial_examples.red_button_scripts - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tutorial\_examples.tests module ------------------------------------------------ - -.. automodule:: evennia.contrib.tutorial_examples.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.contrib.tutorial_examples.bodyfunctions + evennia.contrib.tutorial_examples.cmdset_red_button + evennia.contrib.tutorial_examples.example_batch_code + evennia.contrib.tutorial_examples.red_button + evennia.contrib.tutorial_examples.red_button_scripts + evennia.contrib.tutorial_examples.tests diff --git a/docs/source/api/evennia.contrib.tutorial_examples.tests.rst b/docs/source/api/evennia.contrib.tutorial_examples.tests.rst new file mode 100644 index 0000000000..fe4da272e3 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_examples.tests.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_examples.tests +=============================================== + +.. automodule:: evennia.contrib.tutorial_examples.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_world.mob.rst b/docs/source/api/evennia.contrib.tutorial_world.mob.rst new file mode 100644 index 0000000000..582e0c73a9 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_world.mob.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_world.mob +========================================== + +.. automodule:: evennia.contrib.tutorial_world.mob + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_world.objects.rst b/docs/source/api/evennia.contrib.tutorial_world.objects.rst new file mode 100644 index 0000000000..c06b56a556 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_world.objects.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_world.objects +============================================== + +.. automodule:: evennia.contrib.tutorial_world.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_world.rooms.rst b/docs/source/api/evennia.contrib.tutorial_world.rooms.rst new file mode 100644 index 0000000000..c229d89ab2 --- /dev/null +++ b/docs/source/api/evennia.contrib.tutorial_world.rooms.rst @@ -0,0 +1,7 @@ +evennia.contrib.tutorial\_world.rooms +============================================ + +.. automodule:: evennia.contrib.tutorial_world.rooms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.tutorial_world.rst b/docs/source/api/evennia.contrib.tutorial_world.rst index cfb41d40e1..3bd191cebe 100644 --- a/docs/source/api/evennia.contrib.tutorial_world.rst +++ b/docs/source/api/evennia.contrib.tutorial_world.rst @@ -1,4 +1,4 @@ -evennia.contrib.tutorial\_world package +evennia.contrib.tutorial\_world ======================================= .. automodule:: evennia.contrib.tutorial_world @@ -9,27 +9,9 @@ evennia.contrib.tutorial\_world package Submodules ---------- -evennia.contrib.tutorial\_world.mob module ------------------------------------------- - -.. automodule:: evennia.contrib.tutorial_world.mob - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tutorial\_world.objects module ----------------------------------------------- - -.. automodule:: evennia.contrib.tutorial_world.objects - :members: - :undoc-members: - :show-inheritance: - -evennia.contrib.tutorial\_world.rooms module --------------------------------------------- - -.. automodule:: evennia.contrib.tutorial_world.rooms - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.contrib.tutorial_world.mob + evennia.contrib.tutorial_world.objects + evennia.contrib.tutorial_world.rooms diff --git a/docs/source/api/evennia.contrib.unixcommand.rst b/docs/source/api/evennia.contrib.unixcommand.rst new file mode 100644 index 0000000000..ac6ddaff56 --- /dev/null +++ b/docs/source/api/evennia.contrib.unixcommand.rst @@ -0,0 +1,7 @@ +evennia.contrib.unixcommand +================================== + +.. automodule:: evennia.contrib.unixcommand + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.contrib.wilderness.rst b/docs/source/api/evennia.contrib.wilderness.rst new file mode 100644 index 0000000000..03f01a3996 --- /dev/null +++ b/docs/source/api/evennia.contrib.wilderness.rst @@ -0,0 +1,7 @@ +evennia.contrib.wilderness +================================= + +.. automodule:: evennia.contrib.wilderness + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.game_template.commands.rst b/docs/source/api/evennia.game_template.commands.rst deleted file mode 100644 index d474233c19..0000000000 --- a/docs/source/api/evennia.game_template.commands.rst +++ /dev/null @@ -1,27 +0,0 @@ -evennia.game\_template.commands package -======================================= - -.. automodule:: evennia.game_template.commands - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.game\_template.commands.command module ----------------------------------------------- - -.. automodule:: evennia.game_template.commands.command - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.commands.default\_cmdsets module -------------------------------------------------------- - -.. automodule:: evennia.game_template.commands.default_cmdsets - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.game_template.rst b/docs/source/api/evennia.game_template.rst deleted file mode 100644 index bcceadd7f1..0000000000 --- a/docs/source/api/evennia.game_template.rst +++ /dev/null @@ -1,18 +0,0 @@ -evennia.game\_template package -============================== - -.. automodule:: evennia.game_template - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - - evennia.game_template.commands - evennia.game_template.server - evennia.game_template.typeclasses - evennia.game_template.web - evennia.game_template.world diff --git a/docs/source/api/evennia.game_template.server.conf.rst b/docs/source/api/evennia.game_template.server.conf.rst deleted file mode 100644 index 1985e1989a..0000000000 --- a/docs/source/api/evennia.game_template.server.conf.rst +++ /dev/null @@ -1,131 +0,0 @@ -evennia.game\_template.server.conf package -========================================== - -.. automodule:: evennia.game_template.server.conf - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.game\_template.server.conf.at\_initial\_setup module ------------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.at_initial_setup - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.at\_search module ----------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.at_search - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.at\_server\_startstop module ---------------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.at_server_startstop - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.cmdparser module ---------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.cmdparser - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.connection\_screens module -------------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.connection_screens - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.inlinefuncs module ------------------------------------------------------ - -.. automodule:: evennia.game_template.server.conf.inlinefuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.inputfuncs module ----------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.inputfuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.lockfuncs module ---------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.lockfuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.mssp module ----------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.mssp - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.portal\_services\_plugins module -------------------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.portal_services_plugins - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.secret\_settings module ----------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.secret_settings - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.server\_services\_plugins module -------------------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.server_services_plugins - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.serversession module -------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.serversession - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.settings module --------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.settings - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.server.conf.web\_plugins module ------------------------------------------------------- - -.. automodule:: evennia.game_template.server.conf.web_plugins - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.game_template.server.rst b/docs/source/api/evennia.game_template.server.rst deleted file mode 100644 index cc56a6be6f..0000000000 --- a/docs/source/api/evennia.game_template.server.rst +++ /dev/null @@ -1,14 +0,0 @@ -evennia.game\_template.server package -===================================== - -.. automodule:: evennia.game_template.server - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - - evennia.game_template.server.conf diff --git a/docs/source/api/evennia.game_template.typeclasses.rst b/docs/source/api/evennia.game_template.typeclasses.rst deleted file mode 100644 index ce621b62f5..0000000000 --- a/docs/source/api/evennia.game_template.typeclasses.rst +++ /dev/null @@ -1,67 +0,0 @@ -evennia.game\_template.typeclasses package -========================================== - -.. automodule:: evennia.game_template.typeclasses - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.game\_template.typeclasses.accounts module --------------------------------------------------- - -.. automodule:: evennia.game_template.typeclasses.accounts - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.typeclasses.channels module --------------------------------------------------- - -.. automodule:: evennia.game_template.typeclasses.channels - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.typeclasses.characters module ----------------------------------------------------- - -.. automodule:: evennia.game_template.typeclasses.characters - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.typeclasses.exits module ------------------------------------------------ - -.. automodule:: evennia.game_template.typeclasses.exits - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.typeclasses.objects module -------------------------------------------------- - -.. automodule:: evennia.game_template.typeclasses.objects - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.typeclasses.rooms module ------------------------------------------------ - -.. automodule:: evennia.game_template.typeclasses.rooms - :members: - :undoc-members: - :show-inheritance: - -evennia.game\_template.typeclasses.scripts module -------------------------------------------------- - -.. automodule:: evennia.game_template.typeclasses.scripts - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.game_template.web.rst b/docs/source/api/evennia.game_template.web.rst deleted file mode 100644 index 7b3e788394..0000000000 --- a/docs/source/api/evennia.game_template.web.rst +++ /dev/null @@ -1,19 +0,0 @@ -evennia.game\_template.web package -================================== - -.. automodule:: evennia.game_template.web - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.game\_template.web.urls module --------------------------------------- - -.. automodule:: evennia.game_template.web.urls - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.game_template.world.rst b/docs/source/api/evennia.game_template.world.rst deleted file mode 100644 index 579fd03a0b..0000000000 --- a/docs/source/api/evennia.game_template.world.rst +++ /dev/null @@ -1,19 +0,0 @@ -evennia.game\_template.world package -==================================== - -.. automodule:: evennia.game_template.world - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.game\_template.world.prototypes module ----------------------------------------------- - -.. automodule:: evennia.game_template.world.prototypes - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.help.admin.rst b/docs/source/api/evennia.help.admin.rst new file mode 100644 index 0000000000..050a9b6d41 --- /dev/null +++ b/docs/source/api/evennia.help.admin.rst @@ -0,0 +1,7 @@ +evennia.help.admin +========================= + +.. automodule:: evennia.help.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.help.manager.rst b/docs/source/api/evennia.help.manager.rst new file mode 100644 index 0000000000..b5a7c258e0 --- /dev/null +++ b/docs/source/api/evennia.help.manager.rst @@ -0,0 +1,7 @@ +evennia.help.manager +=========================== + +.. automodule:: evennia.help.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.help.migrations.rst b/docs/source/api/evennia.help.migrations.rst deleted file mode 100644 index c9c1c65e34..0000000000 --- a/docs/source/api/evennia.help.migrations.rst +++ /dev/null @@ -1,35 +0,0 @@ -evennia.help.migrations package -=============================== - -.. automodule:: evennia.help.migrations - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.help.migrations.0001\_initial module --------------------------------------------- - -.. automodule:: evennia.help.migrations.0001_initial - :members: - :undoc-members: - :show-inheritance: - -evennia.help.migrations.0002\_auto\_20170606\_1731 module ---------------------------------------------------------- - -.. automodule:: evennia.help.migrations.0002_auto_20170606_1731 - :members: - :undoc-members: - :show-inheritance: - -evennia.help.migrations.0003\_auto\_20190128\_1820 module ---------------------------------------------------------- - -.. automodule:: evennia.help.migrations.0003_auto_20190128_1820 - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.help.models.rst b/docs/source/api/evennia.help.models.rst new file mode 100644 index 0000000000..ae17110e65 --- /dev/null +++ b/docs/source/api/evennia.help.models.rst @@ -0,0 +1,7 @@ +evennia.help.models +========================== + +.. automodule:: evennia.help.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.help.rst b/docs/source/api/evennia.help.rst index 77ad511a70..b4ac6ec140 100644 --- a/docs/source/api/evennia.help.rst +++ b/docs/source/api/evennia.help.rst @@ -1,4 +1,4 @@ -evennia.help package +evennia.help ==================== .. automodule:: evennia.help @@ -6,37 +6,12 @@ evennia.help package :undoc-members: :show-inheritance: -Subpackages ------------ - -.. toctree:: - - evennia.help.migrations - Submodules ---------- -evennia.help.admin module -------------------------- - -.. automodule:: evennia.help.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.help.manager module ---------------------------- - -.. automodule:: evennia.help.manager - :members: - :undoc-members: - :show-inheritance: - -evennia.help.models module --------------------------- - -.. automodule:: evennia.help.models - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.help.admin + evennia.help.manager + evennia.help.models diff --git a/docs/source/api/evennia.locks.lockfuncs.rst b/docs/source/api/evennia.locks.lockfuncs.rst new file mode 100644 index 0000000000..b7afd6b666 --- /dev/null +++ b/docs/source/api/evennia.locks.lockfuncs.rst @@ -0,0 +1,7 @@ +evennia.locks.lockfuncs +============================== + +.. automodule:: evennia.locks.lockfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.locks.lockhandler.rst b/docs/source/api/evennia.locks.lockhandler.rst new file mode 100644 index 0000000000..7b6b7312a8 --- /dev/null +++ b/docs/source/api/evennia.locks.lockhandler.rst @@ -0,0 +1,7 @@ +evennia.locks.lockhandler +================================ + +.. automodule:: evennia.locks.lockhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.locks.rst b/docs/source/api/evennia.locks.rst index f8b7ca85a6..18dafc691f 100644 --- a/docs/source/api/evennia.locks.rst +++ b/docs/source/api/evennia.locks.rst @@ -1,4 +1,4 @@ -evennia.locks package +evennia.locks ===================== .. automodule:: evennia.locks @@ -9,27 +9,9 @@ evennia.locks package Submodules ---------- -evennia.locks.lockfuncs module ------------------------------- - -.. automodule:: evennia.locks.lockfuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.locks.lockhandler module --------------------------------- - -.. automodule:: evennia.locks.lockhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.locks.tests module --------------------------- - -.. automodule:: evennia.locks.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.locks.lockfuncs + evennia.locks.lockhandler + evennia.locks.tests diff --git a/docs/source/api/evennia.locks.tests.rst b/docs/source/api/evennia.locks.tests.rst new file mode 100644 index 0000000000..c4d4af7591 --- /dev/null +++ b/docs/source/api/evennia.locks.tests.rst @@ -0,0 +1,7 @@ +evennia.locks.tests +========================== + +.. automodule:: evennia.locks.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.admin.rst b/docs/source/api/evennia.objects.admin.rst new file mode 100644 index 0000000000..6e8c0cfa96 --- /dev/null +++ b/docs/source/api/evennia.objects.admin.rst @@ -0,0 +1,7 @@ +evennia.objects.admin +============================ + +.. automodule:: evennia.objects.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.manager.rst b/docs/source/api/evennia.objects.manager.rst new file mode 100644 index 0000000000..630f96ac16 --- /dev/null +++ b/docs/source/api/evennia.objects.manager.rst @@ -0,0 +1,7 @@ +evennia.objects.manager +============================== + +.. automodule:: evennia.objects.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.migrations.rst b/docs/source/api/evennia.objects.migrations.rst deleted file mode 100644 index cbb8e1b0e0..0000000000 --- a/docs/source/api/evennia.objects.migrations.rst +++ /dev/null @@ -1,99 +0,0 @@ -evennia.objects.migrations package -================================== - -.. automodule:: evennia.objects.migrations - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.objects.migrations.0001\_initial module ------------------------------------------------ - -.. automodule:: evennia.objects.migrations.0001_initial - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0002\_auto\_20140917\_0756 module ------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0002_auto_20140917_0756 - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0003\_defaultcharacter\_defaultexit\_defaultobject\_defaultroom module -------------------------------------------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0003_defaultcharacter_defaultexit_defaultobject_defaultroom - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0004\_auto\_20150118\_1622 module ------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0004_auto_20150118_1622 - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0005\_auto\_20150403\_2339 module ------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0005_auto_20150403_2339 - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0006\_auto\_20170606\_1731 module ------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0006_auto_20170606_1731 - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0007\_objectdb\_db\_account module -------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0007_objectdb_db_account - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0008\_auto\_20170705\_1736 module ------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0008_auto_20170705_1736 - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0009\_remove\_objectdb\_db\_player module --------------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0009_remove_objectdb_db_player - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0010\_auto\_20190128\_1820 module ------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0010_auto_20190128_1820 - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.migrations.0011\_auto\_20191025\_0831 module ------------------------------------------------------------- - -.. automodule:: evennia.objects.migrations.0011_auto_20191025_0831 - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.objects.models.rst b/docs/source/api/evennia.objects.models.rst new file mode 100644 index 0000000000..e1e9ab3ba3 --- /dev/null +++ b/docs/source/api/evennia.objects.models.rst @@ -0,0 +1,7 @@ +evennia.objects.models +============================= + +.. automodule:: evennia.objects.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.objects.rst b/docs/source/api/evennia.objects.objects.rst new file mode 100644 index 0000000000..8a4104feba --- /dev/null +++ b/docs/source/api/evennia.objects.objects.rst @@ -0,0 +1,7 @@ +evennia.objects.objects +============================== + +.. automodule:: evennia.objects.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.objects.rst b/docs/source/api/evennia.objects.rst index 15980b11da..8063232893 100644 --- a/docs/source/api/evennia.objects.rst +++ b/docs/source/api/evennia.objects.rst @@ -1,4 +1,4 @@ -evennia.objects package +evennia.objects ======================= .. automodule:: evennia.objects @@ -6,53 +6,14 @@ evennia.objects package :undoc-members: :show-inheritance: -Subpackages ------------ - -.. toctree:: - - evennia.objects.migrations - Submodules ---------- -evennia.objects.admin module ----------------------------- - -.. automodule:: evennia.objects.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.manager module ------------------------------- - -.. automodule:: evennia.objects.manager - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.models module ------------------------------ - -.. automodule:: evennia.objects.models - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.objects module ------------------------------- - -.. automodule:: evennia.objects.objects - :members: - :undoc-members: - :show-inheritance: - -evennia.objects.tests module ----------------------------- - -.. automodule:: evennia.objects.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.objects.admin + evennia.objects.manager + evennia.objects.models + evennia.objects.objects + evennia.objects.tests diff --git a/docs/source/api/evennia.objects.tests.rst b/docs/source/api/evennia.objects.tests.rst new file mode 100644 index 0000000000..d487265cd2 --- /dev/null +++ b/docs/source/api/evennia.objects.tests.rst @@ -0,0 +1,7 @@ +evennia.objects.tests +============================ + +.. automodule:: evennia.objects.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.menus.rst b/docs/source/api/evennia.prototypes.menus.rst new file mode 100644 index 0000000000..57750c87c1 --- /dev/null +++ b/docs/source/api/evennia.prototypes.menus.rst @@ -0,0 +1,7 @@ +evennia.prototypes.menus +=============================== + +.. automodule:: evennia.prototypes.menus + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.protfuncs.rst b/docs/source/api/evennia.prototypes.protfuncs.rst new file mode 100644 index 0000000000..c4ba2440a8 --- /dev/null +++ b/docs/source/api/evennia.prototypes.protfuncs.rst @@ -0,0 +1,7 @@ +evennia.prototypes.protfuncs +=================================== + +.. automodule:: evennia.prototypes.protfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.prototypes.rst b/docs/source/api/evennia.prototypes.prototypes.rst new file mode 100644 index 0000000000..49f1c4626b --- /dev/null +++ b/docs/source/api/evennia.prototypes.prototypes.rst @@ -0,0 +1,7 @@ +evennia.prototypes.prototypes +==================================== + +.. automodule:: evennia.prototypes.prototypes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.rst b/docs/source/api/evennia.prototypes.rst index bed891762a..4a471dc562 100644 --- a/docs/source/api/evennia.prototypes.rst +++ b/docs/source/api/evennia.prototypes.rst @@ -1,4 +1,4 @@ -evennia.prototypes package +evennia.prototypes ========================== .. automodule:: evennia.prototypes @@ -9,43 +9,11 @@ evennia.prototypes package Submodules ---------- -evennia.prototypes.menus module -------------------------------- - -.. automodule:: evennia.prototypes.menus - :members: - :undoc-members: - :show-inheritance: - -evennia.prototypes.protfuncs module ------------------------------------ - -.. automodule:: evennia.prototypes.protfuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.prototypes.prototypes module ------------------------------------- - -.. automodule:: evennia.prototypes.prototypes - :members: - :undoc-members: - :show-inheritance: - -evennia.prototypes.spawner module ---------------------------------- - -.. automodule:: evennia.prototypes.spawner - :members: - :undoc-members: - :show-inheritance: - -evennia.prototypes.tests module -------------------------------- - -.. automodule:: evennia.prototypes.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.prototypes.menus + evennia.prototypes.protfuncs + evennia.prototypes.prototypes + evennia.prototypes.spawner + evennia.prototypes.tests diff --git a/docs/source/api/evennia.prototypes.spawner.rst b/docs/source/api/evennia.prototypes.spawner.rst new file mode 100644 index 0000000000..42b76f5acb --- /dev/null +++ b/docs/source/api/evennia.prototypes.spawner.rst @@ -0,0 +1,7 @@ +evennia.prototypes.spawner +================================= + +.. automodule:: evennia.prototypes.spawner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.prototypes.tests.rst b/docs/source/api/evennia.prototypes.tests.rst new file mode 100644 index 0000000000..93ab94c9e0 --- /dev/null +++ b/docs/source/api/evennia.prototypes.tests.rst @@ -0,0 +1,7 @@ +evennia.prototypes.tests +=============================== + +.. automodule:: evennia.prototypes.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.rst b/docs/source/api/evennia.rst index ded3faf60b..f73b6808e5 100644 --- a/docs/source/api/evennia.rst +++ b/docs/source/api/evennia.rst @@ -1,4 +1,4 @@ -evennia package +evennia =============== .. automodule:: evennia @@ -10,12 +10,12 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.accounts evennia.commands evennia.comms evennia.contrib - evennia.game_template evennia.help evennia.locks evennia.objects @@ -29,11 +29,7 @@ Subpackages Submodules ---------- -evennia.settings\_default module --------------------------------- - -.. automodule:: evennia.settings_default - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.settings_default diff --git a/docs/source/api/evennia.scripts.admin.rst b/docs/source/api/evennia.scripts.admin.rst new file mode 100644 index 0000000000..3825a583d3 --- /dev/null +++ b/docs/source/api/evennia.scripts.admin.rst @@ -0,0 +1,7 @@ +evennia.scripts.admin +============================ + +.. automodule:: evennia.scripts.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.manager.rst b/docs/source/api/evennia.scripts.manager.rst new file mode 100644 index 0000000000..724e6f63c8 --- /dev/null +++ b/docs/source/api/evennia.scripts.manager.rst @@ -0,0 +1,7 @@ +evennia.scripts.manager +============================== + +.. automodule:: evennia.scripts.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.migrations.rst b/docs/source/api/evennia.scripts.migrations.rst deleted file mode 100644 index 2a0a1abb63..0000000000 --- a/docs/source/api/evennia.scripts.migrations.rst +++ /dev/null @@ -1,115 +0,0 @@ -evennia.scripts.migrations package -================================== - -.. automodule:: evennia.scripts.migrations - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.scripts.migrations.0001\_initial module ------------------------------------------------ - -.. automodule:: evennia.scripts.migrations.0001_initial - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0002\_auto\_20150118\_1625 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0002_auto_20150118_1625 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0003\_checksessions\_defaultscript\_donothing\_scriptbase\_store\_validatechannelhandler\_validateidmappercache\_ module ---------------------------------------------------------------------------------------------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0003_checksessions_defaultscript_donothing_scriptbase_store_validatechannelhandler_validateidmappercache_ - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0004\_auto\_20150306\_1354 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0004_auto_20150306_1354 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0005\_auto\_20150306\_1441 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0005_auto_20150306_1441 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0006\_auto\_20150310\_2249 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0006_auto_20150310_2249 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0007\_auto\_20150403\_2339 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0007_auto_20150403_2339 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0008\_auto\_20170606\_1731 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0008_auto_20170606_1731 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0009\_scriptdb\_db\_account module -------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0009_scriptdb_db_account - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0010\_auto\_20170705\_1736 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0010_auto_20170705_1736 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0011\_remove\_scriptdb\_db\_player module --------------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0011_remove_scriptdb_db_player - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0012\_auto\_20190128\_1820 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0012_auto_20190128_1820 - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.migrations.0013\_auto\_20191025\_0831 module ------------------------------------------------------------- - -.. automodule:: evennia.scripts.migrations.0013_auto_20191025_0831 - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.scripts.models.rst b/docs/source/api/evennia.scripts.models.rst new file mode 100644 index 0000000000..b7df7127e5 --- /dev/null +++ b/docs/source/api/evennia.scripts.models.rst @@ -0,0 +1,7 @@ +evennia.scripts.models +============================= + +.. automodule:: evennia.scripts.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.monitorhandler.rst b/docs/source/api/evennia.scripts.monitorhandler.rst new file mode 100644 index 0000000000..8134d61860 --- /dev/null +++ b/docs/source/api/evennia.scripts.monitorhandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.monitorhandler +===================================== + +.. automodule:: evennia.scripts.monitorhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.rst b/docs/source/api/evennia.scripts.rst index 7f11f01b34..0b140af369 100644 --- a/docs/source/api/evennia.scripts.rst +++ b/docs/source/api/evennia.scripts.rst @@ -1,4 +1,4 @@ -evennia.scripts package +evennia.scripts ======================= .. automodule:: evennia.scripts @@ -6,85 +6,18 @@ evennia.scripts package :undoc-members: :show-inheritance: -Subpackages ------------ - -.. toctree:: - - evennia.scripts.migrations - Submodules ---------- -evennia.scripts.admin module ----------------------------- - -.. automodule:: evennia.scripts.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.manager module ------------------------------- - -.. automodule:: evennia.scripts.manager - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.models module ------------------------------ - -.. automodule:: evennia.scripts.models - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.monitorhandler module -------------------------------------- - -.. automodule:: evennia.scripts.monitorhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.scripthandler module ------------------------------------- - -.. automodule:: evennia.scripts.scripthandler - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.scripts module ------------------------------- - -.. automodule:: evennia.scripts.scripts - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.taskhandler module ----------------------------------- - -.. automodule:: evennia.scripts.taskhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.tests module ----------------------------- - -.. automodule:: evennia.scripts.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.scripts.tickerhandler module ------------------------------------- - -.. automodule:: evennia.scripts.tickerhandler - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.scripts.admin + evennia.scripts.manager + evennia.scripts.models + evennia.scripts.monitorhandler + evennia.scripts.scripthandler + evennia.scripts.scripts + evennia.scripts.taskhandler + evennia.scripts.tests + evennia.scripts.tickerhandler diff --git a/docs/source/api/evennia.scripts.scripthandler.rst b/docs/source/api/evennia.scripts.scripthandler.rst new file mode 100644 index 0000000000..f5847cfeff --- /dev/null +++ b/docs/source/api/evennia.scripts.scripthandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.scripthandler +==================================== + +.. automodule:: evennia.scripts.scripthandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.scripts.rst b/docs/source/api/evennia.scripts.scripts.rst new file mode 100644 index 0000000000..81e470a811 --- /dev/null +++ b/docs/source/api/evennia.scripts.scripts.rst @@ -0,0 +1,7 @@ +evennia.scripts.scripts +============================== + +.. automodule:: evennia.scripts.scripts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.taskhandler.rst b/docs/source/api/evennia.scripts.taskhandler.rst new file mode 100644 index 0000000000..afd858d97b --- /dev/null +++ b/docs/source/api/evennia.scripts.taskhandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.taskhandler +================================== + +.. automodule:: evennia.scripts.taskhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.tests.rst b/docs/source/api/evennia.scripts.tests.rst new file mode 100644 index 0000000000..2307ec7de7 --- /dev/null +++ b/docs/source/api/evennia.scripts.tests.rst @@ -0,0 +1,7 @@ +evennia.scripts.tests +============================ + +.. automodule:: evennia.scripts.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.scripts.tickerhandler.rst b/docs/source/api/evennia.scripts.tickerhandler.rst new file mode 100644 index 0000000000..2489a6b500 --- /dev/null +++ b/docs/source/api/evennia.scripts.tickerhandler.rst @@ -0,0 +1,7 @@ +evennia.scripts.tickerhandler +==================================== + +.. automodule:: evennia.scripts.tickerhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.admin.rst b/docs/source/api/evennia.server.admin.rst new file mode 100644 index 0000000000..d87b5fe3d4 --- /dev/null +++ b/docs/source/api/evennia.server.admin.rst @@ -0,0 +1,7 @@ +evennia.server.admin +=========================== + +.. automodule:: evennia.server.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.amp_client.rst b/docs/source/api/evennia.server.amp_client.rst new file mode 100644 index 0000000000..763a2d9018 --- /dev/null +++ b/docs/source/api/evennia.server.amp_client.rst @@ -0,0 +1,7 @@ +evennia.server.amp\_client +================================= + +.. automodule:: evennia.server.amp_client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.connection_wizard.rst b/docs/source/api/evennia.server.connection_wizard.rst new file mode 100644 index 0000000000..96d614c9f0 --- /dev/null +++ b/docs/source/api/evennia.server.connection_wizard.rst @@ -0,0 +1,7 @@ +evennia.server.connection\_wizard +======================================== + +.. automodule:: evennia.server.connection_wizard + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.deprecations.rst b/docs/source/api/evennia.server.deprecations.rst new file mode 100644 index 0000000000..b5e535c387 --- /dev/null +++ b/docs/source/api/evennia.server.deprecations.rst @@ -0,0 +1,7 @@ +evennia.server.deprecations +================================== + +.. automodule:: evennia.server.deprecations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.evennia_launcher.rst b/docs/source/api/evennia.server.evennia_launcher.rst new file mode 100644 index 0000000000..44f5481260 --- /dev/null +++ b/docs/source/api/evennia.server.evennia_launcher.rst @@ -0,0 +1,7 @@ +evennia.server.evennia\_launcher +======================================= + +.. automodule:: evennia.server.evennia_launcher + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.game_index_client.client.rst b/docs/source/api/evennia.server.game_index_client.client.rst new file mode 100644 index 0000000000..44b4ba8dac --- /dev/null +++ b/docs/source/api/evennia.server.game_index_client.client.rst @@ -0,0 +1,7 @@ +evennia.server.game\_index\_client.client +================================================ + +.. automodule:: evennia.server.game_index_client.client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.game_index_client.rst b/docs/source/api/evennia.server.game_index_client.rst index bfc785e850..050760ce64 100644 --- a/docs/source/api/evennia.server.game_index_client.rst +++ b/docs/source/api/evennia.server.game_index_client.rst @@ -1,4 +1,4 @@ -evennia.server.game\_index\_client package +evennia.server.game\_index\_client ========================================== .. automodule:: evennia.server.game_index_client @@ -9,19 +9,8 @@ evennia.server.game\_index\_client package Submodules ---------- -evennia.server.game\_index\_client.client module ------------------------------------------------- - -.. automodule:: evennia.server.game_index_client.client - :members: - :undoc-members: - :show-inheritance: - -evennia.server.game\_index\_client.service module -------------------------------------------------- - -.. automodule:: evennia.server.game_index_client.service - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.server.game_index_client.client + evennia.server.game_index_client.service diff --git a/docs/source/api/evennia.server.game_index_client.service.rst b/docs/source/api/evennia.server.game_index_client.service.rst new file mode 100644 index 0000000000..f60df1f31e --- /dev/null +++ b/docs/source/api/evennia.server.game_index_client.service.rst @@ -0,0 +1,7 @@ +evennia.server.game\_index\_client.service +================================================= + +.. automodule:: evennia.server.game_index_client.service + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.initial_setup.rst b/docs/source/api/evennia.server.initial_setup.rst new file mode 100644 index 0000000000..c7f8d2d38c --- /dev/null +++ b/docs/source/api/evennia.server.initial_setup.rst @@ -0,0 +1,7 @@ +evennia.server.initial\_setup +==================================== + +.. automodule:: evennia.server.initial_setup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.inputfuncs.rst b/docs/source/api/evennia.server.inputfuncs.rst new file mode 100644 index 0000000000..cbdc1fdc03 --- /dev/null +++ b/docs/source/api/evennia.server.inputfuncs.rst @@ -0,0 +1,7 @@ +evennia.server.inputfuncs +================================ + +.. automodule:: evennia.server.inputfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.manager.rst b/docs/source/api/evennia.server.manager.rst new file mode 100644 index 0000000000..8e32f2999b --- /dev/null +++ b/docs/source/api/evennia.server.manager.rst @@ -0,0 +1,7 @@ +evennia.server.manager +============================= + +.. automodule:: evennia.server.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.migrations.rst b/docs/source/api/evennia.server.migrations.rst deleted file mode 100644 index 902aaad7a0..0000000000 --- a/docs/source/api/evennia.server.migrations.rst +++ /dev/null @@ -1,27 +0,0 @@ -evennia.server.migrations package -================================= - -.. automodule:: evennia.server.migrations - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.server.migrations.0001\_initial module ----------------------------------------------- - -.. automodule:: evennia.server.migrations.0001_initial - :members: - :undoc-members: - :show-inheritance: - -evennia.server.migrations.0002\_auto\_20190128\_2311 module ------------------------------------------------------------ - -.. automodule:: evennia.server.migrations.0002_auto_20190128_2311 - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.server.models.rst b/docs/source/api/evennia.server.models.rst new file mode 100644 index 0000000000..ca0707bb57 --- /dev/null +++ b/docs/source/api/evennia.server.models.rst @@ -0,0 +1,7 @@ +evennia.server.models +============================ + +.. automodule:: evennia.server.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.amp.rst b/docs/source/api/evennia.server.portal.amp.rst new file mode 100644 index 0000000000..b59d7b2da9 --- /dev/null +++ b/docs/source/api/evennia.server.portal.amp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.amp +================================ + +.. automodule:: evennia.server.portal.amp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.amp_server.rst b/docs/source/api/evennia.server.portal.amp_server.rst new file mode 100644 index 0000000000..c6a598cb63 --- /dev/null +++ b/docs/source/api/evennia.server.portal.amp_server.rst @@ -0,0 +1,7 @@ +evennia.server.portal.amp\_server +======================================== + +.. automodule:: evennia.server.portal.amp_server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.grapevine.rst b/docs/source/api/evennia.server.portal.grapevine.rst new file mode 100644 index 0000000000..6287761e2b --- /dev/null +++ b/docs/source/api/evennia.server.portal.grapevine.rst @@ -0,0 +1,7 @@ +evennia.server.portal.grapevine +====================================== + +.. automodule:: evennia.server.portal.grapevine + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.irc.rst b/docs/source/api/evennia.server.portal.irc.rst new file mode 100644 index 0000000000..e15163e5ba --- /dev/null +++ b/docs/source/api/evennia.server.portal.irc.rst @@ -0,0 +1,7 @@ +evennia.server.portal.irc +================================ + +.. automodule:: evennia.server.portal.irc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.mccp.rst b/docs/source/api/evennia.server.portal.mccp.rst new file mode 100644 index 0000000000..8f553bb148 --- /dev/null +++ b/docs/source/api/evennia.server.portal.mccp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.mccp +================================= + +.. automodule:: evennia.server.portal.mccp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.mssp.rst b/docs/source/api/evennia.server.portal.mssp.rst new file mode 100644 index 0000000000..5f252224fc --- /dev/null +++ b/docs/source/api/evennia.server.portal.mssp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.mssp +================================= + +.. automodule:: evennia.server.portal.mssp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.mxp.rst b/docs/source/api/evennia.server.portal.mxp.rst new file mode 100644 index 0000000000..7e313e75f5 --- /dev/null +++ b/docs/source/api/evennia.server.portal.mxp.rst @@ -0,0 +1,7 @@ +evennia.server.portal.mxp +================================ + +.. automodule:: evennia.server.portal.mxp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.naws.rst b/docs/source/api/evennia.server.portal.naws.rst new file mode 100644 index 0000000000..171887ac80 --- /dev/null +++ b/docs/source/api/evennia.server.portal.naws.rst @@ -0,0 +1,7 @@ +evennia.server.portal.naws +================================= + +.. automodule:: evennia.server.portal.naws + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.portal.rst b/docs/source/api/evennia.server.portal.portal.rst new file mode 100644 index 0000000000..cefe2044c2 --- /dev/null +++ b/docs/source/api/evennia.server.portal.portal.rst @@ -0,0 +1,7 @@ +evennia.server.portal.portal +=================================== + +.. automodule:: evennia.server.portal.portal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.portalsessionhandler.rst b/docs/source/api/evennia.server.portal.portalsessionhandler.rst new file mode 100644 index 0000000000..aee1ee4291 --- /dev/null +++ b/docs/source/api/evennia.server.portal.portalsessionhandler.rst @@ -0,0 +1,7 @@ +evennia.server.portal.portalsessionhandler +================================================= + +.. automodule:: evennia.server.portal.portalsessionhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.rss.rst b/docs/source/api/evennia.server.portal.rss.rst new file mode 100644 index 0000000000..8c315fff1f --- /dev/null +++ b/docs/source/api/evennia.server.portal.rss.rst @@ -0,0 +1,7 @@ +evennia.server.portal.rss +================================ + +.. automodule:: evennia.server.portal.rss + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.rst b/docs/source/api/evennia.server.portal.rst index 38f0e3e943..812ea3ca4a 100644 --- a/docs/source/api/evennia.server.portal.rst +++ b/docs/source/api/evennia.server.portal.rst @@ -1,4 +1,4 @@ -evennia.server.portal package +evennia.server.portal ============================= .. automodule:: evennia.server.portal @@ -9,171 +9,27 @@ evennia.server.portal package Submodules ---------- -evennia.server.portal.amp module --------------------------------- - -.. automodule:: evennia.server.portal.amp - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.amp\_server module ----------------------------------------- - -.. automodule:: evennia.server.portal.amp_server - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.grapevine module --------------------------------------- - -.. automodule:: evennia.server.portal.grapevine - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.irc module --------------------------------- - -.. automodule:: evennia.server.portal.irc - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.mccp module ---------------------------------- - -.. automodule:: evennia.server.portal.mccp - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.mssp module ---------------------------------- - -.. automodule:: evennia.server.portal.mssp - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.mxp module --------------------------------- - -.. automodule:: evennia.server.portal.mxp - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.naws module ---------------------------------- - -.. automodule:: evennia.server.portal.naws - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.portal module ------------------------------------ - -.. automodule:: evennia.server.portal.portal - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.portalsessionhandler module -------------------------------------------------- - -.. automodule:: evennia.server.portal.portalsessionhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.rss module --------------------------------- - -.. automodule:: evennia.server.portal.rss - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.ssh module --------------------------------- - -.. automodule:: evennia.server.portal.ssh - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.ssl module --------------------------------- - -.. automodule:: evennia.server.portal.ssl - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.suppress\_ga module ------------------------------------------ - -.. automodule:: evennia.server.portal.suppress_ga - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.telnet module ------------------------------------ - -.. automodule:: evennia.server.portal.telnet - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.telnet\_oob module ----------------------------------------- - -.. automodule:: evennia.server.portal.telnet_oob - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.telnet\_ssl module ----------------------------------------- - -.. automodule:: evennia.server.portal.telnet_ssl - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.tests module ----------------------------------- - -.. automodule:: evennia.server.portal.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.ttype module ----------------------------------- - -.. automodule:: evennia.server.portal.ttype - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.webclient module --------------------------------------- - -.. automodule:: evennia.server.portal.webclient - :members: - :undoc-members: - :show-inheritance: - -evennia.server.portal.webclient\_ajax module --------------------------------------------- - -.. automodule:: evennia.server.portal.webclient_ajax - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.server.portal.amp + evennia.server.portal.amp_server + evennia.server.portal.grapevine + evennia.server.portal.irc + evennia.server.portal.mccp + evennia.server.portal.mssp + evennia.server.portal.mxp + evennia.server.portal.naws + evennia.server.portal.portal + evennia.server.portal.portalsessionhandler + evennia.server.portal.rss + evennia.server.portal.ssh + evennia.server.portal.ssl + evennia.server.portal.suppress_ga + evennia.server.portal.telnet + evennia.server.portal.telnet_oob + evennia.server.portal.telnet_ssl + evennia.server.portal.tests + evennia.server.portal.ttype + evennia.server.portal.webclient + evennia.server.portal.webclient_ajax diff --git a/docs/source/api/evennia.server.portal.ssh.rst b/docs/source/api/evennia.server.portal.ssh.rst new file mode 100644 index 0000000000..81be6edfe2 --- /dev/null +++ b/docs/source/api/evennia.server.portal.ssh.rst @@ -0,0 +1,7 @@ +evennia.server.portal.ssh +================================ + +.. automodule:: evennia.server.portal.ssh + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.ssl.rst b/docs/source/api/evennia.server.portal.ssl.rst new file mode 100644 index 0000000000..40d8e43c50 --- /dev/null +++ b/docs/source/api/evennia.server.portal.ssl.rst @@ -0,0 +1,7 @@ +evennia.server.portal.ssl +================================ + +.. automodule:: evennia.server.portal.ssl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.suppress_ga.rst b/docs/source/api/evennia.server.portal.suppress_ga.rst new file mode 100644 index 0000000000..995605401e --- /dev/null +++ b/docs/source/api/evennia.server.portal.suppress_ga.rst @@ -0,0 +1,7 @@ +evennia.server.portal.suppress\_ga +========================================= + +.. automodule:: evennia.server.portal.suppress_ga + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.telnet.rst b/docs/source/api/evennia.server.portal.telnet.rst new file mode 100644 index 0000000000..e0907d6adf --- /dev/null +++ b/docs/source/api/evennia.server.portal.telnet.rst @@ -0,0 +1,7 @@ +evennia.server.portal.telnet +=================================== + +.. automodule:: evennia.server.portal.telnet + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.telnet_oob.rst b/docs/source/api/evennia.server.portal.telnet_oob.rst new file mode 100644 index 0000000000..e022fdc155 --- /dev/null +++ b/docs/source/api/evennia.server.portal.telnet_oob.rst @@ -0,0 +1,7 @@ +evennia.server.portal.telnet\_oob +======================================== + +.. automodule:: evennia.server.portal.telnet_oob + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.telnet_ssl.rst b/docs/source/api/evennia.server.portal.telnet_ssl.rst new file mode 100644 index 0000000000..e7d0793c63 --- /dev/null +++ b/docs/source/api/evennia.server.portal.telnet_ssl.rst @@ -0,0 +1,7 @@ +evennia.server.portal.telnet\_ssl +======================================== + +.. automodule:: evennia.server.portal.telnet_ssl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.tests.rst b/docs/source/api/evennia.server.portal.tests.rst new file mode 100644 index 0000000000..a614af7899 --- /dev/null +++ b/docs/source/api/evennia.server.portal.tests.rst @@ -0,0 +1,7 @@ +evennia.server.portal.tests +================================== + +.. automodule:: evennia.server.portal.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.ttype.rst b/docs/source/api/evennia.server.portal.ttype.rst new file mode 100644 index 0000000000..e3b9194f09 --- /dev/null +++ b/docs/source/api/evennia.server.portal.ttype.rst @@ -0,0 +1,7 @@ +evennia.server.portal.ttype +================================== + +.. automodule:: evennia.server.portal.ttype + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.webclient.rst b/docs/source/api/evennia.server.portal.webclient.rst new file mode 100644 index 0000000000..8094e933c1 --- /dev/null +++ b/docs/source/api/evennia.server.portal.webclient.rst @@ -0,0 +1,7 @@ +evennia.server.portal.webclient +====================================== + +.. automodule:: evennia.server.portal.webclient + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.portal.webclient_ajax.rst b/docs/source/api/evennia.server.portal.webclient_ajax.rst new file mode 100644 index 0000000000..0b1dc79d7f --- /dev/null +++ b/docs/source/api/evennia.server.portal.webclient_ajax.rst @@ -0,0 +1,7 @@ +evennia.server.portal.webclient\_ajax +============================================ + +.. automodule:: evennia.server.portal.webclient_ajax + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.dummyrunner.rst b/docs/source/api/evennia.server.profiling.dummyrunner.rst new file mode 100644 index 0000000000..e94afaa250 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.dummyrunner.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.dummyrunner +=========================================== + +.. automodule:: evennia.server.profiling.dummyrunner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.dummyrunner_settings.rst b/docs/source/api/evennia.server.profiling.dummyrunner_settings.rst new file mode 100644 index 0000000000..76e6c0d337 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.dummyrunner_settings.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.dummyrunner\_settings +===================================================== + +.. automodule:: evennia.server.profiling.dummyrunner_settings + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.memplot.rst b/docs/source/api/evennia.server.profiling.memplot.rst new file mode 100644 index 0000000000..76aa3a695b --- /dev/null +++ b/docs/source/api/evennia.server.profiling.memplot.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.memplot +======================================= + +.. automodule:: evennia.server.profiling.memplot + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.rst b/docs/source/api/evennia.server.profiling.rst index 61c687247a..57cccbba34 100644 --- a/docs/source/api/evennia.server.profiling.rst +++ b/docs/source/api/evennia.server.profiling.rst @@ -1,4 +1,4 @@ -evennia.server.profiling package +evennia.server.profiling ================================ .. automodule:: evennia.server.profiling @@ -9,59 +9,13 @@ evennia.server.profiling package Submodules ---------- -evennia.server.profiling.dummyrunner module -------------------------------------------- - -.. automodule:: evennia.server.profiling.dummyrunner - :members: - :undoc-members: - :show-inheritance: - -evennia.server.profiling.dummyrunner\_settings module ------------------------------------------------------ - -.. automodule:: evennia.server.profiling.dummyrunner_settings - :members: - :undoc-members: - :show-inheritance: - -evennia.server.profiling.memplot module ---------------------------------------- - -.. automodule:: evennia.server.profiling.memplot - :members: - :undoc-members: - :show-inheritance: - -evennia.server.profiling.settings\_mixin module ------------------------------------------------ - -.. automodule:: evennia.server.profiling.settings_mixin - :members: - :undoc-members: - :show-inheritance: - -evennia.server.profiling.test\_queries module ---------------------------------------------- - -.. automodule:: evennia.server.profiling.test_queries - :members: - :undoc-members: - :show-inheritance: - -evennia.server.profiling.tests module -------------------------------------- - -.. automodule:: evennia.server.profiling.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.server.profiling.timetrace module ------------------------------------------ - -.. automodule:: evennia.server.profiling.timetrace - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.server.profiling.dummyrunner + evennia.server.profiling.dummyrunner_settings + evennia.server.profiling.memplot + evennia.server.profiling.settings_mixin + evennia.server.profiling.test_queries + evennia.server.profiling.tests + evennia.server.profiling.timetrace diff --git a/docs/source/api/evennia.server.profiling.settings_mixin.rst b/docs/source/api/evennia.server.profiling.settings_mixin.rst new file mode 100644 index 0000000000..a1ad9e2c7f --- /dev/null +++ b/docs/source/api/evennia.server.profiling.settings_mixin.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.settings\_mixin +=============================================== + +.. automodule:: evennia.server.profiling.settings_mixin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.test_queries.rst b/docs/source/api/evennia.server.profiling.test_queries.rst new file mode 100644 index 0000000000..eb741b38c2 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.test_queries.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.test\_queries +============================================= + +.. automodule:: evennia.server.profiling.test_queries + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.tests.rst b/docs/source/api/evennia.server.profiling.tests.rst new file mode 100644 index 0000000000..7aa7dfe7b6 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.tests.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.tests +===================================== + +.. automodule:: evennia.server.profiling.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.profiling.timetrace.rst b/docs/source/api/evennia.server.profiling.timetrace.rst new file mode 100644 index 0000000000..b6f2be3640 --- /dev/null +++ b/docs/source/api/evennia.server.profiling.timetrace.rst @@ -0,0 +1,7 @@ +evennia.server.profiling.timetrace +========================================= + +.. automodule:: evennia.server.profiling.timetrace + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.rst b/docs/source/api/evennia.server.rst index 5a3cae2db9..8d006d5f03 100644 --- a/docs/source/api/evennia.server.rst +++ b/docs/source/api/evennia.server.rst @@ -1,4 +1,4 @@ -evennia.server package +evennia.server ====================== .. automodule:: evennia.server @@ -10,9 +10,9 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.server.game_index_client - evennia.server.migrations evennia.server.portal evennia.server.profiling evennia.server.tests @@ -20,139 +20,23 @@ Subpackages Submodules ---------- -evennia.server.admin module ---------------------------- - -.. automodule:: evennia.server.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.server.amp\_client module ---------------------------------- - -.. automodule:: evennia.server.amp_client - :members: - :undoc-members: - :show-inheritance: - -evennia.server.connection\_wizard module ----------------------------------------- - -.. automodule:: evennia.server.connection_wizard - :members: - :undoc-members: - :show-inheritance: - -evennia.server.deprecations module ----------------------------------- - -.. automodule:: evennia.server.deprecations - :members: - :undoc-members: - :show-inheritance: - -evennia.server.evennia\_launcher module ---------------------------------------- - -.. automodule:: evennia.server.evennia_launcher - :members: - :undoc-members: - :show-inheritance: - -evennia.server.initial\_setup module ------------------------------------- - -.. automodule:: evennia.server.initial_setup - :members: - :undoc-members: - :show-inheritance: - -evennia.server.inputfuncs module --------------------------------- - -.. automodule:: evennia.server.inputfuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.server.manager module ------------------------------ - -.. automodule:: evennia.server.manager - :members: - :undoc-members: - :show-inheritance: - -evennia.server.models module ----------------------------- - -.. automodule:: evennia.server.models - :members: - :undoc-members: - :show-inheritance: - -evennia.server.server module ----------------------------- - -.. automodule:: evennia.server.server - :members: - :undoc-members: - :show-inheritance: - -evennia.server.serversession module ------------------------------------ - -.. automodule:: evennia.server.serversession - :members: - :undoc-members: - :show-inheritance: - -evennia.server.session module ------------------------------ - -.. automodule:: evennia.server.session - :members: - :undoc-members: - :show-inheritance: - -evennia.server.sessionhandler module ------------------------------------- - -.. automodule:: evennia.server.sessionhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.server.signals module ------------------------------ - -.. automodule:: evennia.server.signals - :members: - :undoc-members: - :show-inheritance: - -evennia.server.throttle module ------------------------------- - -.. automodule:: evennia.server.throttle - :members: - :undoc-members: - :show-inheritance: - -evennia.server.validators module --------------------------------- - -.. automodule:: evennia.server.validators - :members: - :undoc-members: - :show-inheritance: - -evennia.server.webserver module -------------------------------- - -.. automodule:: evennia.server.webserver - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.server.admin + evennia.server.amp_client + evennia.server.connection_wizard + evennia.server.deprecations + evennia.server.evennia_launcher + evennia.server.initial_setup + evennia.server.inputfuncs + evennia.server.manager + evennia.server.models + evennia.server.server + evennia.server.serversession + evennia.server.session + evennia.server.sessionhandler + evennia.server.signals + evennia.server.throttle + evennia.server.validators + evennia.server.webserver diff --git a/docs/source/api/evennia.server.server.rst b/docs/source/api/evennia.server.server.rst new file mode 100644 index 0000000000..b91f32f316 --- /dev/null +++ b/docs/source/api/evennia.server.server.rst @@ -0,0 +1,7 @@ +evennia.server.server +============================ + +.. automodule:: evennia.server.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.serversession.rst b/docs/source/api/evennia.server.serversession.rst new file mode 100644 index 0000000000..88ea4c1d91 --- /dev/null +++ b/docs/source/api/evennia.server.serversession.rst @@ -0,0 +1,7 @@ +evennia.server.serversession +=================================== + +.. automodule:: evennia.server.serversession + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.session.rst b/docs/source/api/evennia.server.session.rst new file mode 100644 index 0000000000..af1796466d --- /dev/null +++ b/docs/source/api/evennia.server.session.rst @@ -0,0 +1,7 @@ +evennia.server.session +============================= + +.. automodule:: evennia.server.session + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.sessionhandler.rst b/docs/source/api/evennia.server.sessionhandler.rst new file mode 100644 index 0000000000..47e62524bd --- /dev/null +++ b/docs/source/api/evennia.server.sessionhandler.rst @@ -0,0 +1,7 @@ +evennia.server.sessionhandler +==================================== + +.. automodule:: evennia.server.sessionhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.signals.rst b/docs/source/api/evennia.server.signals.rst new file mode 100644 index 0000000000..00cae2d4cf --- /dev/null +++ b/docs/source/api/evennia.server.signals.rst @@ -0,0 +1,7 @@ +evennia.server.signals +============================= + +.. automodule:: evennia.server.signals + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.tests.rst b/docs/source/api/evennia.server.tests.rst index 0f73171fde..b567e6e18f 100644 --- a/docs/source/api/evennia.server.tests.rst +++ b/docs/source/api/evennia.server.tests.rst @@ -1,4 +1,4 @@ -evennia.server.tests package +evennia.server.tests ============================ .. automodule:: evennia.server.tests @@ -9,51 +9,12 @@ evennia.server.tests package Submodules ---------- -evennia.server.tests.test\_amp\_connection module -------------------------------------------------- - -.. automodule:: evennia.server.tests.test_amp_connection - :members: - :undoc-members: - :show-inheritance: - -evennia.server.tests.test\_initial\_setup module ------------------------------------------------- - -.. automodule:: evennia.server.tests.test_initial_setup - :members: - :undoc-members: - :show-inheritance: - -evennia.server.tests.test\_launcher module ------------------------------------------- - -.. automodule:: evennia.server.tests.test_launcher - :members: - :undoc-members: - :show-inheritance: - -evennia.server.tests.test\_misc module --------------------------------------- - -.. automodule:: evennia.server.tests.test_misc - :members: - :undoc-members: - :show-inheritance: - -evennia.server.tests.test\_server module ----------------------------------------- - -.. automodule:: evennia.server.tests.test_server - :members: - :undoc-members: - :show-inheritance: - -evennia.server.tests.testrunner module --------------------------------------- - -.. automodule:: evennia.server.tests.testrunner - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.server.tests.test_amp_connection + evennia.server.tests.test_initial_setup + evennia.server.tests.test_launcher + evennia.server.tests.test_misc + evennia.server.tests.test_server + evennia.server.tests.testrunner diff --git a/docs/source/api/evennia.server.tests.test_amp_connection.rst b/docs/source/api/evennia.server.tests.test_amp_connection.rst new file mode 100644 index 0000000000..87430e1a02 --- /dev/null +++ b/docs/source/api/evennia.server.tests.test_amp_connection.rst @@ -0,0 +1,7 @@ +evennia.server.tests.test\_amp\_connection +================================================= + +.. automodule:: evennia.server.tests.test_amp_connection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.tests.test_initial_setup.rst b/docs/source/api/evennia.server.tests.test_initial_setup.rst new file mode 100644 index 0000000000..0bb8f23649 --- /dev/null +++ b/docs/source/api/evennia.server.tests.test_initial_setup.rst @@ -0,0 +1,7 @@ +evennia.server.tests.test\_initial\_setup +================================================ + +.. automodule:: evennia.server.tests.test_initial_setup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.tests.test_launcher.rst b/docs/source/api/evennia.server.tests.test_launcher.rst new file mode 100644 index 0000000000..d79e2ed0a0 --- /dev/null +++ b/docs/source/api/evennia.server.tests.test_launcher.rst @@ -0,0 +1,7 @@ +evennia.server.tests.test\_launcher +========================================== + +.. automodule:: evennia.server.tests.test_launcher + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.tests.test_misc.rst b/docs/source/api/evennia.server.tests.test_misc.rst new file mode 100644 index 0000000000..5ca4ac6eb8 --- /dev/null +++ b/docs/source/api/evennia.server.tests.test_misc.rst @@ -0,0 +1,7 @@ +evennia.server.tests.test\_misc +====================================== + +.. automodule:: evennia.server.tests.test_misc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.tests.test_server.rst b/docs/source/api/evennia.server.tests.test_server.rst new file mode 100644 index 0000000000..057605cd73 --- /dev/null +++ b/docs/source/api/evennia.server.tests.test_server.rst @@ -0,0 +1,7 @@ +evennia.server.tests.test\_server +======================================== + +.. automodule:: evennia.server.tests.test_server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.tests.testrunner.rst b/docs/source/api/evennia.server.tests.testrunner.rst new file mode 100644 index 0000000000..8f2d6f614c --- /dev/null +++ b/docs/source/api/evennia.server.tests.testrunner.rst @@ -0,0 +1,7 @@ +evennia.server.tests.testrunner +====================================== + +.. automodule:: evennia.server.tests.testrunner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.throttle.rst b/docs/source/api/evennia.server.throttle.rst new file mode 100644 index 0000000000..6d3ccdd516 --- /dev/null +++ b/docs/source/api/evennia.server.throttle.rst @@ -0,0 +1,7 @@ +evennia.server.throttle +============================== + +.. automodule:: evennia.server.throttle + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.validators.rst b/docs/source/api/evennia.server.validators.rst new file mode 100644 index 0000000000..defe37284f --- /dev/null +++ b/docs/source/api/evennia.server.validators.rst @@ -0,0 +1,7 @@ +evennia.server.validators +================================ + +.. automodule:: evennia.server.validators + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.server.webserver.rst b/docs/source/api/evennia.server.webserver.rst new file mode 100644 index 0000000000..0ff51e3aa7 --- /dev/null +++ b/docs/source/api/evennia.server.webserver.rst @@ -0,0 +1,7 @@ +evennia.server.webserver +=============================== + +.. automodule:: evennia.server.webserver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.settings_default.rst b/docs/source/api/evennia.settings_default.rst new file mode 100644 index 0000000000..957d582a6f --- /dev/null +++ b/docs/source/api/evennia.settings_default.rst @@ -0,0 +1,7 @@ +evennia.settings\_default +================================ + +.. automodule:: evennia.settings_default + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.admin.rst b/docs/source/api/evennia.typeclasses.admin.rst new file mode 100644 index 0000000000..48b745cfcd --- /dev/null +++ b/docs/source/api/evennia.typeclasses.admin.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.admin +================================ + +.. automodule:: evennia.typeclasses.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.attributes.rst b/docs/source/api/evennia.typeclasses.attributes.rst new file mode 100644 index 0000000000..35cc09605f --- /dev/null +++ b/docs/source/api/evennia.typeclasses.attributes.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.attributes +===================================== + +.. automodule:: evennia.typeclasses.attributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.managers.rst b/docs/source/api/evennia.typeclasses.managers.rst new file mode 100644 index 0000000000..0aa284fa34 --- /dev/null +++ b/docs/source/api/evennia.typeclasses.managers.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.managers +=================================== + +.. automodule:: evennia.typeclasses.managers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.migrations.rst b/docs/source/api/evennia.typeclasses.migrations.rst deleted file mode 100644 index 88c995c961..0000000000 --- a/docs/source/api/evennia.typeclasses.migrations.rst +++ /dev/null @@ -1,115 +0,0 @@ -evennia.typeclasses.migrations package -====================================== - -.. automodule:: evennia.typeclasses.migrations - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -evennia.typeclasses.migrations.0001\_initial module ---------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0001_initial - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0002\_auto\_20150109\_0913 module ----------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0002_auto_20150109_0913 - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0003\_defaultcharacter\_defaultexit\_defaultguest\_defaultobject\_defaultplayer\_defaultroom\_defaultscript\_dono module -------------------------------------------------------------------------------------------------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0003_defaultcharacter_defaultexit_defaultguest_defaultobject_defaultplayer_defaultroom_defaultscript_dono - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0004\_auto\_20151101\_1759 module ----------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0004_auto_20151101_1759 - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0005\_auto\_20160625\_1812 module ----------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0005_auto_20160625_1812 - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0006\_auto\_add\_dbmodel\_value\_for\_tags\_attributes module --------------------------------------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0006_auto_add_dbmodel_value_for_tags_attributes - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0007\_tag\_migrations\_may\_be\_slow module --------------------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0007_tag_migrations_may_be_slow - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0008\_lock\_and\_perm\_rename module -------------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0008_lock_and_perm_rename - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0009\_rename\_player\_cmdsets\_typeclasses module --------------------------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0009_rename_player_cmdsets_typeclasses - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0010\_delete\_old\_player\_tables module ------------------------------------------------------------------------ - -.. automodule:: evennia.typeclasses.migrations.0010_delete_old_player_tables - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0011\_auto\_20190128\_1820 module ----------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0011_auto_20190128_1820 - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0012\_attrs\_to\_picklev4\_may\_be\_slow module ------------------------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0012_attrs_to_picklev4_may_be_slow - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.migrations.0013\_auto\_20191015\_1922 module ----------------------------------------------------------------- - -.. automodule:: evennia.typeclasses.migrations.0013_auto_20191015_1922 - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/evennia.typeclasses.models.rst b/docs/source/api/evennia.typeclasses.models.rst new file mode 100644 index 0000000000..cf953234aa --- /dev/null +++ b/docs/source/api/evennia.typeclasses.models.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.models +================================= + +.. automodule:: evennia.typeclasses.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.rst b/docs/source/api/evennia.typeclasses.rst index 4f05c5bc3a..49a1926eae 100644 --- a/docs/source/api/evennia.typeclasses.rst +++ b/docs/source/api/evennia.typeclasses.rst @@ -1,4 +1,4 @@ -evennia.typeclasses package +evennia.typeclasses =========================== .. automodule:: evennia.typeclasses @@ -6,61 +6,15 @@ evennia.typeclasses package :undoc-members: :show-inheritance: -Subpackages ------------ - -.. toctree:: - - evennia.typeclasses.migrations - Submodules ---------- -evennia.typeclasses.admin module --------------------------------- - -.. automodule:: evennia.typeclasses.admin - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.attributes module -------------------------------------- - -.. automodule:: evennia.typeclasses.attributes - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.managers module ------------------------------------ - -.. automodule:: evennia.typeclasses.managers - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.models module ---------------------------------- - -.. automodule:: evennia.typeclasses.models - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.tags module -------------------------------- - -.. automodule:: evennia.typeclasses.tags - :members: - :undoc-members: - :show-inheritance: - -evennia.typeclasses.tests module --------------------------------- - -.. automodule:: evennia.typeclasses.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.typeclasses.admin + evennia.typeclasses.attributes + evennia.typeclasses.managers + evennia.typeclasses.models + evennia.typeclasses.tags + evennia.typeclasses.tests diff --git a/docs/source/api/evennia.typeclasses.tags.rst b/docs/source/api/evennia.typeclasses.tags.rst new file mode 100644 index 0000000000..b06a17c992 --- /dev/null +++ b/docs/source/api/evennia.typeclasses.tags.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.tags +=============================== + +.. automodule:: evennia.typeclasses.tags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.typeclasses.tests.rst b/docs/source/api/evennia.typeclasses.tests.rst new file mode 100644 index 0000000000..40dc3e9bbf --- /dev/null +++ b/docs/source/api/evennia.typeclasses.tests.rst @@ -0,0 +1,7 @@ +evennia.typeclasses.tests +================================ + +.. automodule:: evennia.typeclasses.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.ansi.rst b/docs/source/api/evennia.utils.ansi.rst new file mode 100644 index 0000000000..afcff5068e --- /dev/null +++ b/docs/source/api/evennia.utils.ansi.rst @@ -0,0 +1,7 @@ +evennia.utils.ansi +========================= + +.. automodule:: evennia.utils.ansi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.batchprocessors.rst b/docs/source/api/evennia.utils.batchprocessors.rst new file mode 100644 index 0000000000..d57178f06f --- /dev/null +++ b/docs/source/api/evennia.utils.batchprocessors.rst @@ -0,0 +1,7 @@ +evennia.utils.batchprocessors +==================================== + +.. automodule:: evennia.utils.batchprocessors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.containers.rst b/docs/source/api/evennia.utils.containers.rst new file mode 100644 index 0000000000..afb8d3be8e --- /dev/null +++ b/docs/source/api/evennia.utils.containers.rst @@ -0,0 +1,7 @@ +evennia.utils.containers +=============================== + +.. automodule:: evennia.utils.containers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.create.rst b/docs/source/api/evennia.utils.create.rst new file mode 100644 index 0000000000..82155c6a1f --- /dev/null +++ b/docs/source/api/evennia.utils.create.rst @@ -0,0 +1,7 @@ +evennia.utils.create +=========================== + +.. automodule:: evennia.utils.create + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.dbserialize.rst b/docs/source/api/evennia.utils.dbserialize.rst new file mode 100644 index 0000000000..1e1252833d --- /dev/null +++ b/docs/source/api/evennia.utils.dbserialize.rst @@ -0,0 +1,7 @@ +evennia.utils.dbserialize +================================ + +.. automodule:: evennia.utils.dbserialize + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.eveditor.rst b/docs/source/api/evennia.utils.eveditor.rst new file mode 100644 index 0000000000..8786ac7cb4 --- /dev/null +++ b/docs/source/api/evennia.utils.eveditor.rst @@ -0,0 +1,7 @@ +evennia.utils.eveditor +============================= + +.. automodule:: evennia.utils.eveditor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evform.rst b/docs/source/api/evennia.utils.evform.rst new file mode 100644 index 0000000000..d64f6d53c0 --- /dev/null +++ b/docs/source/api/evennia.utils.evform.rst @@ -0,0 +1,7 @@ +evennia.utils.evform +=========================== + +.. automodule:: evennia.utils.evform + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evmenu.rst b/docs/source/api/evennia.utils.evmenu.rst new file mode 100644 index 0000000000..fb39ca682e --- /dev/null +++ b/docs/source/api/evennia.utils.evmenu.rst @@ -0,0 +1,7 @@ +evennia.utils.evmenu +=========================== + +.. automodule:: evennia.utils.evmenu + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evmore.rst b/docs/source/api/evennia.utils.evmore.rst new file mode 100644 index 0000000000..3c7b5ce0cf --- /dev/null +++ b/docs/source/api/evennia.utils.evmore.rst @@ -0,0 +1,7 @@ +evennia.utils.evmore +=========================== + +.. automodule:: evennia.utils.evmore + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.evtable.rst b/docs/source/api/evennia.utils.evtable.rst new file mode 100644 index 0000000000..c9bc29d19c --- /dev/null +++ b/docs/source/api/evennia.utils.evtable.rst @@ -0,0 +1,7 @@ +evennia.utils.evtable +============================ + +.. automodule:: evennia.utils.evtable + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.gametime.rst b/docs/source/api/evennia.utils.gametime.rst new file mode 100644 index 0000000000..2dc576077f --- /dev/null +++ b/docs/source/api/evennia.utils.gametime.rst @@ -0,0 +1,7 @@ +evennia.utils.gametime +============================= + +.. automodule:: evennia.utils.gametime + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.idmapper.manager.rst b/docs/source/api/evennia.utils.idmapper.manager.rst new file mode 100644 index 0000000000..d06168459f --- /dev/null +++ b/docs/source/api/evennia.utils.idmapper.manager.rst @@ -0,0 +1,7 @@ +evennia.utils.idmapper.manager +===================================== + +.. automodule:: evennia.utils.idmapper.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.idmapper.models.rst b/docs/source/api/evennia.utils.idmapper.models.rst new file mode 100644 index 0000000000..4859c68678 --- /dev/null +++ b/docs/source/api/evennia.utils.idmapper.models.rst @@ -0,0 +1,7 @@ +evennia.utils.idmapper.models +==================================== + +.. automodule:: evennia.utils.idmapper.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.idmapper.rst b/docs/source/api/evennia.utils.idmapper.rst index a07302808d..f398e4c5f1 100644 --- a/docs/source/api/evennia.utils.idmapper.rst +++ b/docs/source/api/evennia.utils.idmapper.rst @@ -1,4 +1,4 @@ -evennia.utils.idmapper package +evennia.utils.idmapper ============================== .. automodule:: evennia.utils.idmapper @@ -9,27 +9,9 @@ evennia.utils.idmapper package Submodules ---------- -evennia.utils.idmapper.manager module -------------------------------------- - -.. automodule:: evennia.utils.idmapper.manager - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.idmapper.models module ------------------------------------- - -.. automodule:: evennia.utils.idmapper.models - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.idmapper.tests module ------------------------------------ - -.. automodule:: evennia.utils.idmapper.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.utils.idmapper.manager + evennia.utils.idmapper.models + evennia.utils.idmapper.tests diff --git a/docs/source/api/evennia.utils.idmapper.tests.rst b/docs/source/api/evennia.utils.idmapper.tests.rst new file mode 100644 index 0000000000..f74a28e5df --- /dev/null +++ b/docs/source/api/evennia.utils.idmapper.tests.rst @@ -0,0 +1,7 @@ +evennia.utils.idmapper.tests +=================================== + +.. automodule:: evennia.utils.idmapper.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.inlinefuncs.rst b/docs/source/api/evennia.utils.inlinefuncs.rst new file mode 100644 index 0000000000..f11abd4776 --- /dev/null +++ b/docs/source/api/evennia.utils.inlinefuncs.rst @@ -0,0 +1,7 @@ +evennia.utils.inlinefuncs +================================ + +.. automodule:: evennia.utils.inlinefuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.logger.rst b/docs/source/api/evennia.utils.logger.rst new file mode 100644 index 0000000000..06300bb978 --- /dev/null +++ b/docs/source/api/evennia.utils.logger.rst @@ -0,0 +1,7 @@ +evennia.utils.logger +=========================== + +.. automodule:: evennia.utils.logger + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.optionclasses.rst b/docs/source/api/evennia.utils.optionclasses.rst new file mode 100644 index 0000000000..69a2656b51 --- /dev/null +++ b/docs/source/api/evennia.utils.optionclasses.rst @@ -0,0 +1,7 @@ +evennia.utils.optionclasses +================================== + +.. automodule:: evennia.utils.optionclasses + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.optionhandler.rst b/docs/source/api/evennia.utils.optionhandler.rst new file mode 100644 index 0000000000..a20707622f --- /dev/null +++ b/docs/source/api/evennia.utils.optionhandler.rst @@ -0,0 +1,7 @@ +evennia.utils.optionhandler +================================== + +.. automodule:: evennia.utils.optionhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.picklefield.rst b/docs/source/api/evennia.utils.picklefield.rst new file mode 100644 index 0000000000..e01f222211 --- /dev/null +++ b/docs/source/api/evennia.utils.picklefield.rst @@ -0,0 +1,7 @@ +evennia.utils.picklefield +================================ + +.. automodule:: evennia.utils.picklefield + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.rst b/docs/source/api/evennia.utils.rst index e97998052d..9db232257f 100644 --- a/docs/source/api/evennia.utils.rst +++ b/docs/source/api/evennia.utils.rst @@ -1,4 +1,4 @@ -evennia.utils package +evennia.utils ===================== .. automodule:: evennia.utils @@ -10,6 +10,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.utils.idmapper evennia.utils.tests @@ -17,171 +18,27 @@ Subpackages Submodules ---------- -evennia.utils.ansi module -------------------------- - -.. automodule:: evennia.utils.ansi - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.batchprocessors module ------------------------------------- - -.. automodule:: evennia.utils.batchprocessors - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.containers module -------------------------------- - -.. automodule:: evennia.utils.containers - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.create module ---------------------------- - -.. automodule:: evennia.utils.create - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.dbserialize module --------------------------------- - -.. automodule:: evennia.utils.dbserialize - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.eveditor module ------------------------------ - -.. automodule:: evennia.utils.eveditor - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.evform module ---------------------------- - -.. automodule:: evennia.utils.evform - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.evmenu module ---------------------------- - -.. automodule:: evennia.utils.evmenu - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.evmore module ---------------------------- - -.. automodule:: evennia.utils.evmore - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.evtable module ----------------------------- - -.. automodule:: evennia.utils.evtable - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.gametime module ------------------------------ - -.. automodule:: evennia.utils.gametime - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.inlinefuncs module --------------------------------- - -.. automodule:: evennia.utils.inlinefuncs - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.logger module ---------------------------- - -.. automodule:: evennia.utils.logger - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.optionclasses module ----------------------------------- - -.. automodule:: evennia.utils.optionclasses - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.optionhandler module ----------------------------------- - -.. automodule:: evennia.utils.optionhandler - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.picklefield module --------------------------------- - -.. automodule:: evennia.utils.picklefield - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.search module ---------------------------- - -.. automodule:: evennia.utils.search - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.test\_resources module ------------------------------------- - -.. automodule:: evennia.utils.test_resources - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.text2html module ------------------------------- - -.. automodule:: evennia.utils.text2html - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.utils module --------------------------- - -.. automodule:: evennia.utils.utils - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.validatorfuncs module ------------------------------------ - -.. automodule:: evennia.utils.validatorfuncs - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.utils.ansi + evennia.utils.batchprocessors + evennia.utils.containers + evennia.utils.create + evennia.utils.dbserialize + evennia.utils.eveditor + evennia.utils.evform + evennia.utils.evmenu + evennia.utils.evmore + evennia.utils.evtable + evennia.utils.gametime + evennia.utils.inlinefuncs + evennia.utils.logger + evennia.utils.optionclasses + evennia.utils.optionhandler + evennia.utils.picklefield + evennia.utils.search + evennia.utils.test_resources + evennia.utils.text2html + evennia.utils.utils + evennia.utils.validatorfuncs diff --git a/docs/source/api/evennia.utils.search.rst b/docs/source/api/evennia.utils.search.rst new file mode 100644 index 0000000000..6386e9f9c4 --- /dev/null +++ b/docs/source/api/evennia.utils.search.rst @@ -0,0 +1,7 @@ +evennia.utils.search +=========================== + +.. automodule:: evennia.utils.search + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.test_resources.rst b/docs/source/api/evennia.utils.test_resources.rst new file mode 100644 index 0000000000..21fff53743 --- /dev/null +++ b/docs/source/api/evennia.utils.test_resources.rst @@ -0,0 +1,7 @@ +evennia.utils.test\_resources +==================================== + +.. automodule:: evennia.utils.test_resources + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.data.evform_example.rst b/docs/source/api/evennia.utils.tests.data.evform_example.rst new file mode 100644 index 0000000000..27cfe2f738 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.data.evform_example.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.data.evform\_example +=============================================== + +.. automodule:: evennia.utils.tests.data.evform_example + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.data.prototypes_example.rst b/docs/source/api/evennia.utils.tests.data.prototypes_example.rst new file mode 100644 index 0000000000..ec9da9ce9f --- /dev/null +++ b/docs/source/api/evennia.utils.tests.data.prototypes_example.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.data.prototypes\_example +=================================================== + +.. automodule:: evennia.utils.tests.data.prototypes_example + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.data.rst b/docs/source/api/evennia.utils.tests.data.rst index 7124d839f7..d2ce5104bc 100644 --- a/docs/source/api/evennia.utils.tests.data.rst +++ b/docs/source/api/evennia.utils.tests.data.rst @@ -1,4 +1,4 @@ -evennia.utils.tests.data package +evennia.utils.tests.data ================================ .. automodule:: evennia.utils.tests.data @@ -9,19 +9,8 @@ evennia.utils.tests.data package Submodules ---------- -evennia.utils.tests.data.evform\_example module ------------------------------------------------ - -.. automodule:: evennia.utils.tests.data.evform_example - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.data.prototypes\_example module ---------------------------------------------------- - -.. automodule:: evennia.utils.tests.data.prototypes_example - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.utils.tests.data.evform_example + evennia.utils.tests.data.prototypes_example diff --git a/docs/source/api/evennia.utils.tests.rst b/docs/source/api/evennia.utils.tests.rst index 18e78e4d74..a863119241 100644 --- a/docs/source/api/evennia.utils.tests.rst +++ b/docs/source/api/evennia.utils.tests.rst @@ -1,4 +1,4 @@ -evennia.utils.tests package +evennia.utils.tests =========================== .. automodule:: evennia.utils.tests @@ -10,97 +10,24 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.utils.tests.data Submodules ---------- -evennia.utils.tests.test\_ansi module -------------------------------------- - -.. automodule:: evennia.utils.tests.test_ansi - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_batchprocessors module ------------------------------------------------- - -.. automodule:: evennia.utils.tests.test_batchprocessors - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_create\_functions module --------------------------------------------------- - -.. automodule:: evennia.utils.tests.test_create_functions - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_eveditor module ------------------------------------------ - -.. automodule:: evennia.utils.tests.test_eveditor - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_evform module ---------------------------------------- - -.. automodule:: evennia.utils.tests.test_evform - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_evmenu module ---------------------------------------- - -.. automodule:: evennia.utils.tests.test_evmenu - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_gametime module ------------------------------------------ - -.. automodule:: evennia.utils.tests.test_gametime - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_tagparsing module -------------------------------------------- - -.. automodule:: evennia.utils.tests.test_tagparsing - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_text2html module ------------------------------------------- - -.. automodule:: evennia.utils.tests.test_text2html - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_utils module --------------------------------------- - -.. automodule:: evennia.utils.tests.test_utils - :members: - :undoc-members: - :show-inheritance: - -evennia.utils.tests.test\_validatorfuncs module ------------------------------------------------ - -.. automodule:: evennia.utils.tests.test_validatorfuncs - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.utils.tests.test_ansi + evennia.utils.tests.test_batchprocessors + evennia.utils.tests.test_create_functions + evennia.utils.tests.test_eveditor + evennia.utils.tests.test_evform + evennia.utils.tests.test_evmenu + evennia.utils.tests.test_gametime + evennia.utils.tests.test_tagparsing + evennia.utils.tests.test_text2html + evennia.utils.tests.test_utils + evennia.utils.tests.test_validatorfuncs diff --git a/docs/source/api/evennia.utils.tests.test_ansi.rst b/docs/source/api/evennia.utils.tests.test_ansi.rst new file mode 100644 index 0000000000..b6c2c5f128 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_ansi.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_ansi +===================================== + +.. automodule:: evennia.utils.tests.test_ansi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_batchprocessors.rst b/docs/source/api/evennia.utils.tests.test_batchprocessors.rst new file mode 100644 index 0000000000..24bd0f3258 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_batchprocessors.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_batchprocessors +================================================ + +.. automodule:: evennia.utils.tests.test_batchprocessors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_create_functions.rst b/docs/source/api/evennia.utils.tests.test_create_functions.rst new file mode 100644 index 0000000000..73f5dd3d62 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_create_functions.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_create\_functions +================================================== + +.. automodule:: evennia.utils.tests.test_create_functions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_eveditor.rst b/docs/source/api/evennia.utils.tests.test_eveditor.rst new file mode 100644 index 0000000000..3461b0faa6 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_eveditor.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_eveditor +========================================= + +.. automodule:: evennia.utils.tests.test_eveditor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_evform.rst b/docs/source/api/evennia.utils.tests.test_evform.rst new file mode 100644 index 0000000000..02878c0f49 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_evform.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_evform +======================================= + +.. automodule:: evennia.utils.tests.test_evform + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_evmenu.rst b/docs/source/api/evennia.utils.tests.test_evmenu.rst new file mode 100644 index 0000000000..166473e78c --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_evmenu.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_evmenu +======================================= + +.. automodule:: evennia.utils.tests.test_evmenu + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_gametime.rst b/docs/source/api/evennia.utils.tests.test_gametime.rst new file mode 100644 index 0000000000..18b3bcb826 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_gametime.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_gametime +========================================= + +.. automodule:: evennia.utils.tests.test_gametime + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_tagparsing.rst b/docs/source/api/evennia.utils.tests.test_tagparsing.rst new file mode 100644 index 0000000000..265498a8cc --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_tagparsing.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_tagparsing +=========================================== + +.. automodule:: evennia.utils.tests.test_tagparsing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_text2html.rst b/docs/source/api/evennia.utils.tests.test_text2html.rst new file mode 100644 index 0000000000..86c0f8c3bc --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_text2html.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_text2html +========================================== + +.. automodule:: evennia.utils.tests.test_text2html + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_utils.rst b/docs/source/api/evennia.utils.tests.test_utils.rst new file mode 100644 index 0000000000..0a00d02001 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_utils.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_utils +====================================== + +.. automodule:: evennia.utils.tests.test_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.tests.test_validatorfuncs.rst b/docs/source/api/evennia.utils.tests.test_validatorfuncs.rst new file mode 100644 index 0000000000..655b9243d6 --- /dev/null +++ b/docs/source/api/evennia.utils.tests.test_validatorfuncs.rst @@ -0,0 +1,7 @@ +evennia.utils.tests.test\_validatorfuncs +=============================================== + +.. automodule:: evennia.utils.tests.test_validatorfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.text2html.rst b/docs/source/api/evennia.utils.text2html.rst new file mode 100644 index 0000000000..07ea0382e2 --- /dev/null +++ b/docs/source/api/evennia.utils.text2html.rst @@ -0,0 +1,7 @@ +evennia.utils.text2html +============================== + +.. automodule:: evennia.utils.text2html + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.utils.rst b/docs/source/api/evennia.utils.utils.rst new file mode 100644 index 0000000000..468fb50711 --- /dev/null +++ b/docs/source/api/evennia.utils.utils.rst @@ -0,0 +1,7 @@ +evennia.utils.utils +========================== + +.. automodule:: evennia.utils.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.utils.validatorfuncs.rst b/docs/source/api/evennia.utils.validatorfuncs.rst new file mode 100644 index 0000000000..e2781cb83f --- /dev/null +++ b/docs/source/api/evennia.utils.validatorfuncs.rst @@ -0,0 +1,7 @@ +evennia.utils.validatorfuncs +=================================== + +.. automodule:: evennia.utils.validatorfuncs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.filters.rst b/docs/source/api/evennia.web.api.filters.rst new file mode 100644 index 0000000000..9fbf183043 --- /dev/null +++ b/docs/source/api/evennia.web.api.filters.rst @@ -0,0 +1,7 @@ +evennia.web.api.filters +============================== + +.. automodule:: evennia.web.api.filters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.permissions.rst b/docs/source/api/evennia.web.api.permissions.rst new file mode 100644 index 0000000000..cf1fd8dc4c --- /dev/null +++ b/docs/source/api/evennia.web.api.permissions.rst @@ -0,0 +1,7 @@ +evennia.web.api.permissions +================================== + +.. automodule:: evennia.web.api.permissions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.rst b/docs/source/api/evennia.web.api.rst index fb31841818..6f891368e7 100644 --- a/docs/source/api/evennia.web.api.rst +++ b/docs/source/api/evennia.web.api.rst @@ -1,4 +1,4 @@ -evennia.web.api package +evennia.web.api ======================= .. automodule:: evennia.web.api @@ -9,51 +9,12 @@ evennia.web.api package Submodules ---------- -evennia.web.api.filters module ------------------------------- - -.. automodule:: evennia.web.api.filters - :members: - :undoc-members: - :show-inheritance: - -evennia.web.api.permissions module ----------------------------------- - -.. automodule:: evennia.web.api.permissions - :members: - :undoc-members: - :show-inheritance: - -evennia.web.api.serializers module ----------------------------------- - -.. automodule:: evennia.web.api.serializers - :members: - :undoc-members: - :show-inheritance: - -evennia.web.api.tests module ----------------------------- - -.. automodule:: evennia.web.api.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.web.api.urls module ---------------------------- - -.. automodule:: evennia.web.api.urls - :members: - :undoc-members: - :show-inheritance: - -evennia.web.api.views module ----------------------------- - -.. automodule:: evennia.web.api.views - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.web.api.filters + evennia.web.api.permissions + evennia.web.api.serializers + evennia.web.api.tests + evennia.web.api.urls + evennia.web.api.views diff --git a/docs/source/api/evennia.web.api.serializers.rst b/docs/source/api/evennia.web.api.serializers.rst new file mode 100644 index 0000000000..6c98642c96 --- /dev/null +++ b/docs/source/api/evennia.web.api.serializers.rst @@ -0,0 +1,7 @@ +evennia.web.api.serializers +================================== + +.. automodule:: evennia.web.api.serializers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.tests.rst b/docs/source/api/evennia.web.api.tests.rst new file mode 100644 index 0000000000..033b05871e --- /dev/null +++ b/docs/source/api/evennia.web.api.tests.rst @@ -0,0 +1,7 @@ +evennia.web.api.tests +============================ + +.. automodule:: evennia.web.api.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.urls.rst b/docs/source/api/evennia.web.api.urls.rst new file mode 100644 index 0000000000..bff2799de3 --- /dev/null +++ b/docs/source/api/evennia.web.api.urls.rst @@ -0,0 +1,7 @@ +evennia.web.api.urls +=========================== + +.. automodule:: evennia.web.api.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.api.views.rst b/docs/source/api/evennia.web.api.views.rst new file mode 100644 index 0000000000..a9fe57ff7e --- /dev/null +++ b/docs/source/api/evennia.web.api.views.rst @@ -0,0 +1,7 @@ +evennia.web.api.views +============================ + +.. automodule:: evennia.web.api.views + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.rst b/docs/source/api/evennia.web.rst index 807da66150..be30bafce5 100644 --- a/docs/source/api/evennia.web.rst +++ b/docs/source/api/evennia.web.rst @@ -1,4 +1,4 @@ -evennia.web package +evennia.web =================== .. automodule:: evennia.web @@ -10,6 +10,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.web.api evennia.web.utils @@ -19,11 +20,7 @@ Subpackages Submodules ---------- -evennia.web.urls module ------------------------ - -.. automodule:: evennia.web.urls - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.web.urls diff --git a/docs/source/api/evennia.web.urls.rst b/docs/source/api/evennia.web.urls.rst new file mode 100644 index 0000000000..e149189b50 --- /dev/null +++ b/docs/source/api/evennia.web.urls.rst @@ -0,0 +1,7 @@ +evennia.web.urls +======================= + +.. automodule:: evennia.web.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.backends.rst b/docs/source/api/evennia.web.utils.backends.rst new file mode 100644 index 0000000000..801ee69b23 --- /dev/null +++ b/docs/source/api/evennia.web.utils.backends.rst @@ -0,0 +1,7 @@ +evennia.web.utils.backends +================================= + +.. automodule:: evennia.web.utils.backends + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.general_context.rst b/docs/source/api/evennia.web.utils.general_context.rst new file mode 100644 index 0000000000..469a2219d7 --- /dev/null +++ b/docs/source/api/evennia.web.utils.general_context.rst @@ -0,0 +1,7 @@ +evennia.web.utils.general\_context +========================================= + +.. automodule:: evennia.web.utils.general_context + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.middleware.rst b/docs/source/api/evennia.web.utils.middleware.rst new file mode 100644 index 0000000000..60fc1884f0 --- /dev/null +++ b/docs/source/api/evennia.web.utils.middleware.rst @@ -0,0 +1,7 @@ +evennia.web.utils.middleware +=================================== + +.. automodule:: evennia.web.utils.middleware + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.utils.rst b/docs/source/api/evennia.web.utils.rst index 98ac9801f1..0bf5dafeb7 100644 --- a/docs/source/api/evennia.web.utils.rst +++ b/docs/source/api/evennia.web.utils.rst @@ -1,4 +1,4 @@ -evennia.web.utils package +evennia.web.utils ========================= .. automodule:: evennia.web.utils @@ -9,35 +9,10 @@ evennia.web.utils package Submodules ---------- -evennia.web.utils.backends module ---------------------------------- - -.. automodule:: evennia.web.utils.backends - :members: - :undoc-members: - :show-inheritance: - -evennia.web.utils.general\_context module ------------------------------------------ - -.. automodule:: evennia.web.utils.general_context - :members: - :undoc-members: - :show-inheritance: - -evennia.web.utils.middleware module ------------------------------------ - -.. automodule:: evennia.web.utils.middleware - :members: - :undoc-members: - :show-inheritance: - -evennia.web.utils.tests module ------------------------------- - -.. automodule:: evennia.web.utils.tests - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.web.utils.backends + evennia.web.utils.general_context + evennia.web.utils.middleware + evennia.web.utils.tests diff --git a/docs/source/api/evennia.web.utils.tests.rst b/docs/source/api/evennia.web.utils.tests.rst new file mode 100644 index 0000000000..8c10659d0c --- /dev/null +++ b/docs/source/api/evennia.web.utils.tests.rst @@ -0,0 +1,7 @@ +evennia.web.utils.tests +============================== + +.. automodule:: evennia.web.utils.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.webclient.rst b/docs/source/api/evennia.web.webclient.rst index a7efc30a88..f576964a66 100644 --- a/docs/source/api/evennia.web.webclient.rst +++ b/docs/source/api/evennia.web.webclient.rst @@ -1,4 +1,4 @@ -evennia.web.webclient package +evennia.web.webclient ============================= .. automodule:: evennia.web.webclient @@ -9,19 +9,8 @@ evennia.web.webclient package Submodules ---------- -evennia.web.webclient.urls module ---------------------------------- - -.. automodule:: evennia.web.webclient.urls - :members: - :undoc-members: - :show-inheritance: - -evennia.web.webclient.views module ----------------------------------- - -.. automodule:: evennia.web.webclient.views - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.web.webclient.urls + evennia.web.webclient.views diff --git a/docs/source/api/evennia.web.webclient.urls.rst b/docs/source/api/evennia.web.webclient.urls.rst new file mode 100644 index 0000000000..3f5c6df062 --- /dev/null +++ b/docs/source/api/evennia.web.webclient.urls.rst @@ -0,0 +1,7 @@ +evennia.web.webclient.urls +================================= + +.. automodule:: evennia.web.webclient.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.webclient.views.rst b/docs/source/api/evennia.web.webclient.views.rst new file mode 100644 index 0000000000..4c8be0d347 --- /dev/null +++ b/docs/source/api/evennia.web.webclient.views.rst @@ -0,0 +1,7 @@ +evennia.web.webclient.views +================================== + +.. automodule:: evennia.web.webclient.views + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.forms.rst b/docs/source/api/evennia.web.website.forms.rst new file mode 100644 index 0000000000..8847576f1f --- /dev/null +++ b/docs/source/api/evennia.web.website.forms.rst @@ -0,0 +1,7 @@ +evennia.web.website.forms +================================ + +.. automodule:: evennia.web.website.forms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.rst b/docs/source/api/evennia.web.website.rst index d6af0b9611..c1595fbd10 100644 --- a/docs/source/api/evennia.web.website.rst +++ b/docs/source/api/evennia.web.website.rst @@ -1,4 +1,4 @@ -evennia.web.website package +evennia.web.website =========================== .. automodule:: evennia.web.website @@ -10,41 +10,17 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 evennia.web.website.templatetags Submodules ---------- -evennia.web.website.forms module --------------------------------- - -.. automodule:: evennia.web.website.forms - :members: - :undoc-members: - :show-inheritance: - -evennia.web.website.tests module --------------------------------- - -.. automodule:: evennia.web.website.tests - :members: - :undoc-members: - :show-inheritance: - -evennia.web.website.urls module -------------------------------- - -.. automodule:: evennia.web.website.urls - :members: - :undoc-members: - :show-inheritance: - -evennia.web.website.views module --------------------------------- - -.. automodule:: evennia.web.website.views - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.web.website.forms + evennia.web.website.tests + evennia.web.website.urls + evennia.web.website.views diff --git a/docs/source/api/evennia.web.website.templatetags.addclass.rst b/docs/source/api/evennia.web.website.templatetags.addclass.rst new file mode 100644 index 0000000000..f068d8c653 --- /dev/null +++ b/docs/source/api/evennia.web.website.templatetags.addclass.rst @@ -0,0 +1,7 @@ +evennia.web.website.templatetags.addclass +================================================ + +.. automodule:: evennia.web.website.templatetags.addclass + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.templatetags.rst b/docs/source/api/evennia.web.website.templatetags.rst index 2f9b7acf8b..1bcaba8c51 100644 --- a/docs/source/api/evennia.web.website.templatetags.rst +++ b/docs/source/api/evennia.web.website.templatetags.rst @@ -1,4 +1,4 @@ -evennia.web.website.templatetags package +evennia.web.website.templatetags ======================================== .. automodule:: evennia.web.website.templatetags @@ -9,11 +9,7 @@ evennia.web.website.templatetags package Submodules ---------- -evennia.web.website.templatetags.addclass module ------------------------------------------------- - -.. automodule:: evennia.web.website.templatetags.addclass - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + :maxdepth: 4 + evennia.web.website.templatetags.addclass diff --git a/docs/source/api/evennia.web.website.tests.rst b/docs/source/api/evennia.web.website.tests.rst new file mode 100644 index 0000000000..b06e8b8b9e --- /dev/null +++ b/docs/source/api/evennia.web.website.tests.rst @@ -0,0 +1,7 @@ +evennia.web.website.tests +================================ + +.. automodule:: evennia.web.website.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.urls.rst b/docs/source/api/evennia.web.website.urls.rst new file mode 100644 index 0000000000..3ec3132b4c --- /dev/null +++ b/docs/source/api/evennia.web.website.urls.rst @@ -0,0 +1,7 @@ +evennia.web.website.urls +=============================== + +.. automodule:: evennia.web.website.urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/evennia.web.website.views.rst b/docs/source/api/evennia.web.website.views.rst new file mode 100644 index 0000000000..367e8c102a --- /dev/null +++ b/docs/source/api/evennia.web.website.views.rst @@ -0,0 +1,7 @@ +evennia.web.website.views +================================ + +.. automodule:: evennia.web.website.views + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index 60d9385049..7f0290313f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -61,23 +61,7 @@ smv_tag_whitelist = r"^$" # -- Options for HTML output ------------------------------------------------- -# html_theme = "alabaster" -# import stanford_theme -# html_theme = "stanford_theme" -# html_theme_path = [stanford_theme.get_html_theme_path()] -# html_theme = "sunpy" -# import sunpy_sphinx_theme -# html_theme_path = sunpy_sphinx_theme.get_html_theme_path() -# html_theme = 'topos-theme' -# html_theme = 'sphinxdoc' -# html_theme = 'classic' -# html_theme = 'scrolls' -# html_theme = 'agogo' -# html_theme = "traditional" html_theme = "nature" -## html_theme = 'pyramid' -# html_theme = 'bizstyle' -# html_theme = 'epub' # Custom extras for sidebar html_sidebars = { @@ -206,21 +190,33 @@ else: autodoc_default_options = { "members": True, - "undoc-members": True, + "undoc-members": False, "show-inheritance": True, "special-members": "__init__", "enable_eval_rst": True, } +autodoc_member_order = "bysource" +autodoc_typehints = "description" def autodoc_skip_member(app, what, name, obj, skip, options): + """Which members the autodoc should ignore.""" if _no_autodoc: return True - if name.startswith("__") and name != "__init__": + if name.startswith("_") and name != "__init__": return True return False +# clean ANSI colors +from evennia.utils import ansi + +def autodoc_clean_docstring(app, what, name, obj, options, lines): + """Clean docstring of ansi. Must modify lines list in-place""" + for il, line in enumerate(lines): + lines[il] = ansi.strip_raw_ansi(line) + + # Napoleon Google-style docstring parser for autodocs napoleon_google_docstring = True @@ -228,13 +224,13 @@ napoleon_numpy_docstring = False napoleon_include_init_with_doc = False napoleon_include_private_with_doc = False napoleon_include_special_with_doc = False -napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_examples = True napoleon_use_admonition_for_notes = False napoleon_use_admonition_for_references = False napoleon_use_ivar = False napoleon_use_param = True napoleon_use_keyword = True -napoleon_use_rtype = True +napoleon_use_rtype = False # -- Main config setup ------------------------------------------ @@ -243,6 +239,7 @@ napoleon_use_rtype = True def setup(app): app.connect("autodoc-skip-member", autodoc_skip_member) + app.connect("autodoc-process-docstring", autodoc_clean_docstring) app.add_transform(AutoStructify) # build toctree file