Merge pull request #44 from rbberger/doc-fixes (829d11e8) · Commits · 郑智淋 / lammps

doc/src/Section_howto.txt

+1 −1

Original line number	Diff line number	Diff line
		@@ -2123,7 +2123,7 @@ thermo_style custom step temp press v_pxy v_pxz v_pyz v_v11 v_v22 v_v33
		run 100000
		variable v equal (v_v11+v_v22+v_v33)/3.0
		variable ndens equal count(all)/vol
		print "average viscosity: $v \[Pa.s/] @ $T K, $\{ndens\} /A^3" :pre
		print "average viscosity: $v \[Pa.s\] @ $T K, $\{ndens\} /A^3" :pre

		The fifth method is related to the above Green-Kubo method,
		but uses the Einstein formulation, analogous to the Einstein

+21 −0

Original line number	Diff line number	Diff line
		@@ -90,3 +90,24 @@ def promote_doc_keywords(content):

		def filter_multiple_horizontal_rules(content):
		return re.sub(r"----------[\s\n]+----------", '', content)


		def merge_preformatted_sections(content):
		mergable_section_pattern = re.compile(r"\.\. parsed-literal::\n"
		r"\n"
		r"(?P<listingA>(( [^\n]+\n)\|(^\n))+)\n\s*"
		r"^\.\. parsed-literal::\n"
		r"\n"
		r"(?P<listingB>(( [^\n]+\n)\|(^\n))+)\n", re.MULTILINE \| re.DOTALL)

		m = mergable_section_pattern.search(content)

		while m:
		content = mergable_section_pattern.sub(r".. parsed-literal::\n"
		r"\n"
		r"\g<listingA>"
		r"\g<listingB>"
		r"\n", content)
		m = mergable_section_pattern.search(content)

		return content

+6 −1

Original line number	Diff line number	Diff line
		@@ -73,10 +73,13 @@ class RSTMarkup(Markup):
		def unescape_rst_chars(self, text):
		text = text.replace('\\', '')
		text = text.replace('\\^', '^')
		text = text.replace('\\_', '_')
		text = self.unescape_underscore(text)
		text = text.replace('\\\|', '\|')
		return text

		def unescape_underscore(self, text):
		return text.replace('\\_', '_')

		def inline_math(self, text):
		start_pos = text.find("\\(")
		end_pos = text.find("\\)")
		@@ -136,6 +139,7 @@ class RSTFormatting(Formatting):
		return content.strip()

		def preformat(self, content):
		content = self.markup.unescape_underscore(content)
		if self.indent_level > 0:
		return self.list_indent("\n.. parsed-literal::\n\n" + self.indent(content.rstrip()), self.indent_level)
		return "\n.. parsed-literal::\n\n" + self.indent(content.rstrip())
		@@ -355,6 +359,7 @@ class Txt2Rst(TxtParser):
		self.document_filters.append(lammps_filters.detect_and_add_command_to_index)
		self.document_filters.append(lammps_filters.filter_multiple_horizontal_rules)
		self.document_filters.append(lammps_filters.promote_doc_keywords)
		self.document_filters.append(lammps_filters.merge_preformatted_sections)

		def is_ignored_textblock_begin(self, line):
		return line.startswith('<!-- HTML_ONLY -->')

+7 −0

Original line number	Diff line number	Diff line
		@@ -169,6 +169,13 @@ class TestFormatting(unittest.TestCase):
		" Hello\n"
		" World\n\n", s)

		def test_preformat_formatting_with_underscore(self):
		s = self.txt2rst.convert("if MPI.COMM_WORLD.rank == 0:\n"
		" print(\"Potential energy: \", L.eval(\"pe\")) :pre\n")
		self.assertEqual("\n.. parsed-literal::\n\n"
		" if MPI.COMM_WORLD.rank == 0:\n"
		" print(\"Potential energy: \", L.eval(\"pe\"))\n\n", s)

		def test_header_formatting(self):
		s = self.txt2rst.convert("Level 1 :h1\n"
		"Level 2 :h2\n"

0 → 100644

+1 −0

Original line number	Diff line number	Diff line
		*.orig