[DOCS] switch to ansible sphinx theme (#864)

ansible · Sep 27, 2023 · 5f5094f · 5f5094f
1 parent cdea1e8
commit 5f5094f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'receptor'
-copyright = '2021, Red Hat Ansible'
+copyright = 'Red Hat Ansible'
 author = 'Red Hat Ansible'
 
 # The full version, including alpha/beta/rc tags
@@ -45,15 +45,15 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['Thumbs.db', '.DS_Store']
 
-pygments_style = 'sphinx'
-language = None
+pygments_style = 'ansible'
+language = 'en'
 master_doc = 'index'
 source_suffix = '.rst'
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_ansible_theme'
 
 # 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,

diff --git a/docs/source/developer_guide.rst b/docs/source/developer_guide.rst
@@ -24,16 +24,18 @@ Additionally, all code must pass a suite of Go linters. There is a pre-commit ya
 
 See https://pre-commit.com/ and https://golangci-lint.run/ for more details on installing and using these tools.
 
-We are using gomock to generate mocks for our unit tests. The mocks are living inside of a package under the real implementation, prefixed by mock_. An example is the package mock_workceptor under pkg/workceptor.
+We are using gomock to generate mocks for our unit tests. The mocks are living inside of a package under the real implementation, prefixed by ``mock_``. An example is the package mock_workceptor under pkg/workceptor.
 
 In order to genenerate a mock for a particular file, you can run:
 
 .. code::
+
     mockgen -source=pkg/filename.go -destination=pkg/mock_pkg/mock_filename.go
 
 For example, to create/update mocks for Workceptor, we can run:
 
 .. code::
+
     mockgen -source=pkg/workceptor/workceptor.go -destination=pkg/workceptor/mock_workceptor/workceptor.go
 
 Source code

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -1,2 +1,3 @@
 pbr
 sphinx
+sphinx-ansible-theme