项目

projects.admin

Django administration interface for Project and related models.

projects.constants

Default values and other various configuration for projects, including available theme names and repository types.

projects.models

class projects.models.EmailHook(*args, **kwargs)

EmailHook(id, project_id, email)

class projects.models.ImportedFile(*args, **kwargs)

ImportedFile(id, project_id, version_id, name, slug, path, md5)

class projects.models.Project(*args, **kwargs)

Project(id, pub_date, modified_date, name, slug, description, repo, repo_type, project_url, version, copyright, theme, suffix, default_version, default_branch, requirements_file, documentation_type, analytics_code, path, conf_py_file, featured, skip, use_virtualenv, python_interpreter, use_system_packages, django_packages_url, crate_url, privacy_level, version_privacy_level)

all_active_versions()

A temporary workaround for active_versions filtering out things that were active, but failed to build

find(file, version)

A balla API to find files inside of a projects dir.

full_build_path(version='latest')

The path to the build html docs in the project.

full_doc_path(version='latest')

The path to the documentation root in the project.

full_epub_path(version='latest')

The path to the build latex docs in the project.

full_find(file, version)

A balla API to find files inside of a projects dir.

full_latex_path(version='latest')

The path to the build latex docs in the project.

full_man_path(version='latest')

The path to the build latex docs in the project.

get_default_branch()

Get the version representing “latest”

get_default_version()

Get the default version (slug).

Returns self.default_version if the version with that slug actually exists (is built and published). Otherwise returns ‘latest’.

get_docs_url(version_slug=None)

Return a url for the docs. Always use http for now, to avoid content warnings.

rtd_build_path(version='latest')

The path to the build html docs in the project.

rtd_cname_path(cname)

The path to the build html docs in the project.

class projects.models.ProjectRelationship(*args, **kwargs)

ProjectRelationship(id, parent_id, child_id)

class projects.models.WebHook(*args, **kwargs)

WebHook(id, project_id, url)

projects.tasks

Tasks related to projects, including fetching repository code, cleaning conf.py files, and rebuilding documentation.

projects.tasks.update_docs_pull(record=False, pdf=False, man=False, force=False)

A high-level interface that will update all of the projects.

This is mainly used from a cronjob or management command.

projects.utils

Utility functions used by projects.

projects.utils.find_file(file)

Find matching filenames in the current directory and its subdirectories, and return a list of matching filenames.

projects.utils.run(*commands, **kwargs)

Run one or more commands, and return (status, out, err). If more than one command is given, then this is equivalent to chaining them together with &&; if all commands succeed, then (status, out, err) will represent the last successful command. If one command failed, then (status, out, err) will represent the failed command.

projects.utils.safe_write(filename, contents)

Write contents to the given filename. If the filename’s directory does not exist, it is created. Contents are written as UTF-8, ignoring any characters that cannot be encoded as UTF-8.

projects.views

projects.views.public

projects.views.public.project_detail(request, project_slug)

A detail view for a project with various dataz

projects.views.public.project_downloads(request, project_slug)

A detail view for a project with various dataz

projects.views.public.project_index(request, username=None, tag=None)

The list of projects, which will optionally filter by user or tag, in which case a ‘person’ or ‘tag’ will be added to the context

projects.views.public.search(request)

our ghetto site search. see roadmap.

projects.views.public.search_autocomplete(request)

return a json list of project names

projects.views.public.tag_index(request)

List of all tags by most common

projects.views.public.version_autocomplete(request, project_slug)

return a json list of version names

projects.views.private

projects.views.private.export(request, *args, **kwargs)

Export a projects’ docs as a .zip file, including the .rst source

projects.views.private.project_dashboard(request, *args, **kwargs)

A dashboard! If you aint know what that means you aint need to. Essentially we show you an overview of your content.

projects.views.private.project_delete(request, *args, **kwargs)

Make a project as deleted on POST, otherwise show a form asking for confirmation of delete.

projects.views.private.project_edit(request, *args, **kwargs)

Edit an existing project - depending on what type of project is being edited (created or imported) a different form will be displayed

projects.views.private.project_import(request, *args, **kwargs)

Import docs from an repo

projects.views.private.project_manage(request, *args, **kwargs)

The management view for a project, where you will have links to edit the projects’ configuration, edit the files associated with that project, etc.

Now redirects to the normal /projects/<slug> view.

projects.views.private.project_versions(request, *args, **kwargs)

Shows the available versions and lets the user choose which ones he would like to have built.

Read the Docs v: latest
Versions
latest
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.