def append_conf(self, **kwargs): """Modify the given ``conf.py`` file from a whitelisted user's project. """ # Pull config data try: conf_py_path = version_utils.get_conf_py_path(self.version) except ProjectImportError: self._write_config() self.create_index(extension='rst') project = self.version.project # Open file for appending. outfile = codecs.open(project.conf_file(self.version.slug), encoding='utf-8', mode='a') outfile.write("\n") conf_py_path = version_utils.get_conf_py_path(self.version) remote_version = version_utils.get_vcs_version_slug(self.version) github_info = version_utils.get_github_username_repo(self.version) bitbucket_info = version_utils.get_bitbucket_username_repo(self.version) if github_info[0] is None: display_github = False else: display_github = True if bitbucket_info[0] is None: display_bitbucket = False else: display_bitbucket = True rtd_ctx = Context({ 'current_version': self.version.slug, 'project': project, 'settings': settings, 'static_path': STATIC_DIR, 'template_path': TEMPLATE_DIR, 'conf_py_path': conf_py_path, 'api_host': getattr(settings, 'SLUMBER_API_HOST', 'https://readthedocs.org'), # GitHub 'github_user': github_info[0], 'github_repo': github_info[1], 'github_version': remote_version, 'display_github': display_github, # BitBucket 'bitbucket_user': bitbucket_info[0], 'bitbucket_repo': bitbucket_info[1], 'bitbucket_version': remote_version, 'display_bitbucket': display_bitbucket, 'commit': self.version.project.vcs_repo(self.version.slug).commit, }) # Avoid hitting database and API if using Docker build environment if getattr(settings, 'DONT_HIT_API', False): rtd_ctx['versions'] = project.active_versions() rtd_ctx['downloads'] = self.version.get_downloads(pretty=True) else: rtd_ctx['versions'] = project.api_versions() rtd_ctx['downloads'] = (apiv2.version(self.version.pk) .downloads.get()['downloads']) rtd_string = template_loader.get_template('doc_builder/conf.py.tmpl').render(rtd_ctx) outfile.write(rtd_string)
def append_conf(self, **kwargs): """Modify the given ``conf.py`` file from a whitelisted user's project. """ project = self.version.project #Open file for appending. outfile = codecs.open(project.conf_file(self.version.slug), encoding='utf-8', mode='a') outfile.write("\n") conf_py_path = version_utils.get_conf_py_path(self.version) remote_version = version_utils.get_vcs_version_slug(self.version) gitlab_info = version_utils.get_gitlab_username_repo(self.version) github_info = version_utils.get_github_username_repo(self.version) bitbucket_info = version_utils.get_bitbucket_username_repo(self.version) if gitlab_info[0] is None: display_gitlab = False else: display_gitlab = True if github_info[0] is None: display_github = False else: display_github = True if bitbucket_info[0] is None: display_bitbucket = False else: display_bitbucket = True rtd_ctx = Context({ 'versions': project.api_versions(), 'downloads': self.version.get_downloads(pretty=True), 'current_version': self.version.slug, 'project': project, 'settings': settings, 'static_path': STATIC_DIR, 'template_path': TEMPLATE_DIR, 'conf_py_path': conf_py_path, 'downloads': apiv2.version(self.version.pk).downloads.get()['downloads'], 'api_host': getattr(settings, 'SLUMBER_API_HOST', 'https://readthedocs.org'), # GitLab 'gitlab_user': gitlab_info[0], 'gitlab_repo': gitlab_info[1], 'gitlab_version': remote_version, 'display_gitlab': display_gitlab, # GitHub 'github_user': github_info[0], 'github_repo': github_info[1], 'github_version': remote_version, 'display_github': display_github, # BitBucket 'bitbucket_user': bitbucket_info[0], 'bitbucket_repo': bitbucket_info[1], 'bitbucket_version': remote_version, 'display_bitbucket': display_bitbucket, }) rtd_string = template_loader.get_template('doc_builder/conf.py.tmpl').render(rtd_ctx) outfile.write(rtd_string)
def append_conf(self, **kwargs): """Modify the given ``conf.py`` file from a whitelisted user's project. """ project = self.version.project # Open file for appending. outfile = codecs.open(project.conf_file(self.version.slug), encoding="utf-8", mode="a") outfile.write("\n") conf_py_path = version_utils.get_conf_py_path(self.version) remote_version = version_utils.get_vcs_version_slug(self.version) github_info = version_utils.get_github_username_repo(self.version) bitbucket_info = version_utils.get_bitbucket_username_repo(self.version) if github_info[0] is None: display_github = False else: display_github = True if bitbucket_info[0] is None: display_bitbucket = False else: display_bitbucket = True rtd_ctx = Context( { "versions": project.api_versions(), "downloads": self.version.get_downloads(pretty=True), "current_version": self.version.slug, "project": project, "settings": settings, "static_path": STATIC_DIR, "template_path": TEMPLATE_DIR, "conf_py_path": conf_py_path, "downloads": apiv2.version(self.version.pk).downloads.get()["downloads"], "api_host": getattr(settings, "SLUMBER_API_HOST", "https://readthedocs.org"), # GitHub "github_user": github_info[0], "github_repo": github_info[1], "github_version": remote_version, "display_github": display_github, # BitBucket "bitbucket_user": bitbucket_info[0], "bitbucket_repo": bitbucket_info[1], "bitbucket_version": remote_version, "display_bitbucket": display_bitbucket, "commit": self.version.project.vcs_repo(self.version.slug).commit, } ) rtd_string = template_loader.get_template("doc_builder/conf.py.tmpl").render(rtd_ctx) outfile.write(rtd_string)
def append_conf(self, **kwargs): """Modify the given ``conf.py`` file from a whitelisted user's project. """ project = self.version.project # Open file for appending. outfile = codecs.open(project.conf_file(self.version.slug), encoding='utf-8', mode='a') outfile.write("\n") conf_py_path = version_utils.get_conf_py_path(self.version) remote_version = version_utils.get_vcs_version_slug(self.version) github_info = version_utils.get_github_username_repo(self.version) bitbucket_info = version_utils.get_bitbucket_username_repo(self.version) if github_info[0] is None: display_github = False else: display_github = True if bitbucket_info[0] is None: display_bitbucket = False else: display_bitbucket = True rtd_ctx = Context({ 'versions': project.api_versions(), 'downloads': self.version.get_downloads(pretty=True), 'current_version': self.version.slug, 'project': project, 'settings': settings, 'static_path': STATIC_DIR, 'template_path': TEMPLATE_DIR, 'conf_py_path': conf_py_path, 'downloads': apiv2.version(self.version.pk).downloads.get()['downloads'], 'api_host': getattr(settings, 'SLUMBER_API_HOST', 'https://readthedocs.org'), # GitHub 'github_user': github_info[0], 'github_repo': github_info[1], 'github_version': remote_version, 'display_github': display_github, # BitBucket 'bitbucket_user': bitbucket_info[0], 'bitbucket_repo': bitbucket_info[1], 'bitbucket_version': remote_version, 'display_bitbucket': display_bitbucket, 'commit': self.version.project.vcs_repo(self.version.slug).commit, }) rtd_string = template_loader.get_template('doc_builder/conf.py.tmpl').render(rtd_ctx) outfile.write(rtd_string)
def append_conf(self, **kwargs): """Modify the given ``conf.py`` file from a whitelisted user's project. """ # Pull config data try: conf_py_path = version_utils.get_conf_py_path(self.version) except ProjectImportError: self._write_config() self.create_index(extension='rst') project = self.version.project # Open file for appending. try: outfile = codecs.open(project.conf_file(self.version.slug), encoding='utf-8', mode='a') except IOError: trace = sys.exc_info()[2] raise ProjectImportError('Conf file not found'), None, trace outfile.write("\n") conf_py_path = version_utils.get_conf_py_path(self.version) remote_version = version_utils.get_vcs_version_slug(self.version) github_info = version_utils.get_github_username_repo(self.version) bitbucket_info = version_utils.get_bitbucket_username_repo( self.version) if github_info[0] is None: display_github = False else: display_github = True if bitbucket_info[0] is None: display_bitbucket = False else: display_bitbucket = True rtd_ctx = Context({ 'current_version': self.version.slug, 'project': project, 'settings': settings, 'static_path': STATIC_DIR, 'template_path': TEMPLATE_DIR, 'conf_py_path': conf_py_path, 'api_host': getattr(settings, 'SLUMBER_API_HOST', 'https://readthedocs.org'), # GitHub 'github_user': github_info[0], 'github_repo': github_info[1], 'github_version': remote_version, 'display_github': display_github, # BitBucket 'bitbucket_user': bitbucket_info[0], 'bitbucket_repo': bitbucket_info[1], 'bitbucket_version': remote_version, 'display_bitbucket': display_bitbucket, 'commit': self.version.project.vcs_repo(self.version.slug).commit, }) # Avoid hitting database and API if using Docker build environment if getattr(settings, 'DONT_HIT_API', False): rtd_ctx['versions'] = project.active_versions() rtd_ctx['downloads'] = self.version.get_downloads(pretty=True) else: rtd_ctx['versions'] = project.api_versions() rtd_ctx['downloads'] = (apiv2.version( self.version.pk).get()['downloads']) rtd_string = template_loader.get_template( 'doc_builder/conf.py.tmpl').render(rtd_ctx) outfile.write(rtd_string)