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.

Sign up for GitHub

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

Documentation fixes #117

Merged
merged 5 commits into from
Mar 15, 2020
Merged

Documentation fixes #117

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bacccfe
Docs: update to py3
PJK Mar 15, 2020
beb4d66
Docs: Fix a few broken links
PJK Mar 15, 2020
28636f2
Doc: fix float references
PJK Mar 15, 2020
1ff7ffa
Docs: Fix more broken references (sphinx compat changes)
PJK Mar 15, 2020
6a4d069
Doc: Fix bad path reference
PJK Mar 15, 2020
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
Next Next commit
Docs: update to py3
  • Loading branch information
@PJK
PJK committed Mar 15, 2020
commit bacccfe2cc05381171fae019688fff03224f080f
22 changes: 11 additions & 11 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if on_rtd:
print subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True)
print(subprocess.check_output('cd ../..; mkdir doc/build; doxygen', shell=True))


print os.getcwd()
print os.getcwd() + '/../build/doxygen/xml'
print(os.getcwd())
print(os.getcwd() + '/../build/doxygen/xml')

breathe_projects = {
'libcbor': '../build/doxygen/xml'
Expand All @@ -67,8 +67,8 @@
master_doc = 'index'

# General information about the project.
project = u'libcbor'
copyright = u'2014 - 2019, Pavel Kalvoda'
project = 'libcbor'
copyright = '2014 - 2019, Pavel Kalvoda'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -225,8 +225,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'libcbor.tex', u'libcbor Documentation',
u'Pavel Kalvoda', 'manual'),
('index', 'libcbor.tex', 'libcbor Documentation',
'Pavel Kalvoda', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -255,8 +255,8 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'libcbor', u'libcbor Documentation',
[u'Pavel Kalvoda'], 1)
('index', 'libcbor', 'libcbor Documentation',
['Pavel Kalvoda'], 1)
]

# If true, show URL addresses after external links.
Expand All @@ -269,8 +269,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'libcbor', u'libcbor Documentation',
u'Pavel Kalvoda', 'libcbor', 'C library for parsing and generating CBOR.',
('index', 'libcbor', 'libcbor Documentation',
'Pavel Kalvoda', 'libcbor', 'C library for parsing and generating CBOR.',
'Miscellaneous'),
]

Expand Down