Skip to content

Commit

Permalink
update conf add intro
Browse files Browse the repository at this point in the history
  • Loading branch information
phiarchitect committed Nov 13, 2023
1 parent 88f4e59 commit 6526729
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 26 deletions.
54 changes: 28 additions & 26 deletions docsrc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,32 @@
repo = 'euclid'
repo_name = 'euclid'

blog_title = f'{org_name}{repo_name}'
html_title = f'{org_name}{repo_name}'
project = f'{org_name}{repo_name}'
version = '' # The short X.Y version.
release = '' # The full version, including alpha/beta/rc tags.

copyright = f'{year}, {org_name}'
author = f'{org_name}'

# Base URL for the website, required for generating feeds.
# e.g. blog_baseurl = "http://example.com/"
blog_baseurl = f'https://{org}.github.io/{repo}'
html_base_url = blog_baseurl
html_baseurl = blog_baseurl

blog_authors = {
"phi": ("phi ARCHITECT", None),
}

html_context = {
"display_github": True, # Integrate GitHub
"github_user": org, # Username
"github_repo": repo, # Repo name
"github_version": "main", # Version
"conf_py_path": "/docsrc/", # Path in the checkout to the docs root
}
setup_globals(org, org_name, repo, repo_name)

# blog_title = f'{org_name} • {repo_name}'
# html_title = f'{org_name} • {repo_name}'
# project = f'{org_name} • {repo_name}'
# version = '' # The short X.Y version.
# release = '' # The full version, including alpha/beta/rc tags.

# copyright = f'{year}, {org_name}'
# author = f'{org_name}'

# # Base URL for the website, required for generating feeds.
# # e.g. blog_baseurl = "http://example.com/"
# blog_baseurl = f'https://{org}.github.io/{repo}'
# html_base_url = blog_baseurl
# html_baseurl = blog_baseurl

# blog_authors = {
# "phi": ("phi ARCHITECT", None),
# }

# html_context = {
# "display_github": True, # Integrate GitHub
# "github_user": org, # Username
# "github_repo": repo, # Repo name
# "github_version": "main", # Version
# "conf_py_path": "/docsrc/", # Path in the checkout to the docs root
# }

Empty file added docsrc/intro.rst
Empty file.

0 comments on commit 6526729

Please sign in to comment.