Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs with sphinx for HC3 #2315

Merged
merged 5 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@ localrc

dist
releasenotes/build

docs/build
.tox/
terraform_provider_opentelekomcloud.egg-info/
SebastianGode marked this conversation as resolved.
Show resolved Hide resolved
103 changes: 103 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# !!!
# This file is generated out of template in doc-exports repository.
# Beware overwriting it locally.

import os
import sys

extensions = [
'otcdocstheme',
'otc_sphinx_directives',
'myst_parser'
]

otcdocs_auto_name = False
otcdocs_auto_version = False

project = 'Terraform Open Telekom Cloud Provider'
otcdocs_repo_name = 'opentelekomcloud/terraform-provider-opentelekomcloud'
# Those variables are required for edit/bug links

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))

# -- General configuration ----------------------------------------------------
# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not
# what it is expected
smartquotes = False

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#
source_encoding = 'utf-8'

# The master toctree document.
master_doc = 'index'

# General information about the project.
copyright = u'2022-present, Open Telekom Cloud'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
language = 'en'

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False

# -- Options for HTML output --------------------------------------------------

# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
html_theme = 'otcdocs'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
}

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

html_title = "Terraform - Open Telekom Cloud Provider"


# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Do not include sources into the rendered results
html_copy_source = False

# -- Options for PDF output --------------------------------------------------
latex_documents = [
('index',
'terraform_otc.tex',
u'Terraform - Open Telekom Cloud Provider',
u'OpenTelekomCloud', 'manual'),
]
92 changes: 92 additions & 0 deletions docs/data-sources/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Data Sources
SebastianGode marked this conversation as resolved.
Show resolved Hide resolved

```{toctree}
:maxdepth: 2
:hidden:
antiddos_v1
cbr_backup_ids_v3
cbr_backup_v3
cce_addon_template_v3
cce_addon_templates_v3
cce_cluster_kubeconfig_v3
cce_cluster_v3
cce_node_ids_v3
cce_node_v3
compute_availability_zones_v2
compute_bms_flavors_v2
compute_bms_keypairs_v2
compute_bms_nic_v2
compute_bms_server_v2
compute_flavor_v2
compute_instance_v2
compute_instances_v2
csbs_backup_policy_v1
csbs_backup_v1
css_flavor_v1
cts_tracker_v1
dcs_az_v1
dcs_maintainwindow_v1
dcs_product_v1
dds_flavors_v3
dds_instance_v3
deh_host_v1
deh_server_v1
direct_connect_v2
dms_az_v1
dms_maintainwindow_v1
dms_product_v1
dns_zone_v2
dws_flavors_v2
identity_agency_v3
identity_auth_scope_v3
identity_group_v3
identity_project_v3
identity_projects_v3
identity_role_custom_v3
identity_role_v3
identity_user_v3
images_image_v2
kms_data_key_v1
kms_key_v1
lb_certificate_v3
lb_flavor_v3
lb_flavors_v3
lb_listener_v3
lb_loadbalancer_v3
lb_member_ids_v2
nat_gateway_v2
networking_network_v2
networking_port_v2
networking_secgroup_rule_ids_v2
networking_secgroup_v2
obs_bucket
obs_bucket_object
rds_backup_v3
rds_flavors_v1
rds_flavors_v3
rds_instance_v3
rds_versions_v3
rts_software_config
rts_software_deployment
rts_stack_resource_v1
rts_stack_v1
s3_bucket_object
sdrs_domain_v1
sfs_file_system_v2
sfs_turbo_share_v1
vbs_backup_policy_v2
vbs_backup_v2
vpc_bandwidth
vpc_bandwidth_v2
vpc_eip_v1
vpc_peering_v2
vpc_route_ids_v2
vpc_route_v2
vpc_subnet_ids_v1
vpc_subnet_v1
vpc_v1
vpcep_public_service_v1
vpcep_service_v1
vpnaas_service_v2
```

7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
```{toctree}
:maxdepth: 2
:hidden:
data-sources/index
resources/index
```

# Open Telekom Cloud Provider

The Open Telekom Cloud provider is used to interact with the
Expand Down
5 changes: 5 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
sphinx>=2.0.0,!=2.1.0 # BSD
otcdocstheme # Apache-2.0
otc-sphinx-directives>=0.1.0
myst-parser>=2.0.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
Loading