Skip to content

Commit 5fd9661

Browse files
Adding comments about legacy code for existing projects that have man/dash format builds.
1 parent 25e7908 commit 5fd9661

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

readthedocs/builds/constants.py

+3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
('html', _('HTML')),
1313
('pdf', _('PDF')),
1414
('epub', _('Epub')),
15+
# There is currently no support for building man/dash formats, but we keep
16+
# it there since the DB might still contain those values for legacy
17+
# projects.
1518
('man', _('Manpage')),
1619
('dash', _('Dash')),
1720
)

readthedocs/projects/models.py

+10-6
Original file line numberDiff line numberDiff line change
@@ -509,18 +509,22 @@ def full_latex_path(self, version='latest'):
509509
"""
510510
return os.path.join(self.conf_dir(version), "_build", "latex")
511511

512-
def full_man_path(self, version='latest'):
513-
"""
514-
The path to the build man docs in the project.
515-
"""
516-
return os.path.join(self.conf_dir(version), "_build", "man")
517-
518512
def full_epub_path(self, version='latest'):
519513
"""
520514
The path to the build epub docs in the project.
521515
"""
522516
return os.path.join(self.conf_dir(version), "_build", "epub")
523517

518+
# There is currently no support for building man/dash formats, but we keep
519+
# the support there for existing projects. They might have already existing
520+
# legacy builds.
521+
522+
def full_man_path(self, version='latest'):
523+
"""
524+
The path to the build man docs in the project.
525+
"""
526+
return os.path.join(self.conf_dir(version), "_build", "man")
527+
524528
def full_dash_path(self, version='latest'):
525529
"""
526530
The path to the build dash docs in the project.

0 commit comments

Comments
 (0)