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

Add s4 docs #21

Merged
merged 2 commits into from
Jul 20, 2021
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ venv/
build/
*.swp
*.*~
*.iml
.idea/
7 changes: 6 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,14 @@ documentation is created using Sphinx_.
Requirements to build the documentation are:

* Sphinx_, obviously.
* The javasphinx_ extension for Sphinx.
* LaTeX, if you want to create a PDF version of the documentation.

e.g. on Ubuntu:

pip3 install -U Sphinx

sudo apt install latexmk

If you want to creat the HTML documentation using the lovely `RTD theme`_ you
will need to install this as well:

Expand Down
25 changes: 25 additions & 0 deletions exts/javaext/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#
# Copyright 2012-2015 Bronto Software, Inc. and contributors
#
# 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.
#

from .domain import JavaDomain
from .extdoc import javadoc_role


def setup(app):
app.add_domain(JavaDomain)

app.add_config_value('javadoc_url_map', dict(), '')
app.add_role('java:extdoc', javadoc_role)
Loading