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

Fix dropdown menu new issue , etc #1292

Merged
merged 6 commits into from
Sep 5, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ The community is writing guides, installation instructions, and everything you n
- [Issue Tracker](https://github.com/plone/documentation/issues)
- [Source Code](https://github.com/plone/documentation/tree/6-dev)

### Contributing to frontend (Volto), `plone.api`, and `plone.restapi` documentation

Plone documentation consists of this repository, `plone/documentation`, and it includes external packages' documentation through git submodules.
Those packages include:

- [`volto`](https://github.com/plone/volto)
- [`plone.api`](https://github.com/plone/plone.api)
- [`plone.restapi`(https://github.com/plone/plone.restapi)
To contribute documentation, please open a pull request in the appropriate repository.
For details, see [Editing external package documentation](https://6.dev-docs.plone.org/contributing/index.html#contributing-editing-external-package-documentation-label).

## Support

Expand Down
27 changes: 19 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
# to convert quotes and dashes to typographically correct entities.
# Note to maintainers: setting this to `True` will cause contractions and
# hyphenated words to be marked as misspelled by spellchecker.
smartquotes=False
smartquotes = False

# The name of the Pygments (syntax highlighting) style to use.
# pygments_style = "sphinx.pygments_styles.PyramidStyle"
Expand Down Expand Up @@ -136,12 +136,12 @@
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
myst_enable_extensions = [
"deflist", # You will be able to utilise definition lists
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
"linkify", # Identify “bare” web URLs and add hyperlinks.
"colon_fence", # You can also use ::: delimiters to denote code fences,\
# instead of ```.
# instead of ```.
"substitution", # plone.restapi \
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
]

myst_substitutions = {
Expand Down Expand Up @@ -208,8 +208,7 @@
html_logo = "_static/logo.svg"
html_favicon = "_static/favicon.ico"

html_css_files = ["custom.css",
("print.css", {"media": "print"})]
html_css_files = ["custom.css", ("print.css", {"media": "print"})]

# See http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos
todo_include_todos = True
Expand Down Expand Up @@ -258,10 +257,22 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual])
latex_documents = [
("index", "PloneDocumentation.tex", "Plone Documentation",
"The Plone community", "manual"),
(
"index",
"PloneDocumentation.tex",
"Plone Documentation",
"The Plone community",
"manual",
),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = "_static/logo_2x.png"


# suggest edit link
# remark: {{ file_name }} is mandatory in "edit_page_url_template"
html_context = {
"edit_page_url_template": "https://6.dev-docs.plone.org/contributing/index.html?{{ file_name }}#making-contributions-on-github",
}
2 changes: 1 addition & 1 deletion docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Tap, click, or hover over the GitHub Octocat icon for options.
:alt: GitHub navigation menu
```

You can use this menu to quickly navigate to the `documentation` source repository, open an issue, or suggest an edit to the current document.
You can use this menu to quickly navigate to the `documentation` source repository or open an issue.
Note that this navigation convenience is provided only for the `documentation` repository.


Expand Down