# openeuler_documents

**Repository Path**: weiyuchen2013/openeuler_documents

## Basic Information

- **Project Name**: openeuler_documents
- **Description**: openeuler 文档相关内容
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-08
- **Last Updated**: 2024-05-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# openeuler_documents

#### 介绍
openeuler 文档相关内容

#### 软件架构
软件架构说明


#### 安装教程
docker image 制作方案如下：

```
$: docker build -t weiyuchen/sphinx-pdf:v1 .
```

#### 使用说明
1. 修改sphinx doc源码中的conf.py

1）默认字体（楷体）配置如下：
```
latex_engine = "xelatex"

latex_elements = {
    'papersize': 'a4paper',
    'utf8extra': '',
    'inputenc': '',
    'cmappkg': '',
    'fontenc': '',
    'preamble': r'''
		\usepackage{xeCJK}
		\parindent 2em
		\setcounter{tocdepth}{3}
		\renewcommand\familydefault{\ttdefault}
		\renewcommand\CJKfamilydefault{\CJKrmdefault}
	''',
}

# 设置文档
latex_documents = [
    (master_doc, 'openeuler.tex', 'openEuler Embedded使用与开发手册',
     '作者：openEuler Embedded', 'manual', True),
]
```

2）Google noto字体配置如下：
```
latex_engine = "xelatex"

latex_elements = {
    'papersize': 'a4paper',
    'utf8extra': '',
    'inputenc': '',
    'cmappkg': '',
    'fontenc': '',
    'preamble': r'''
        \usepackage{xeCJK}
        \usepackage{indentfirst}
        \setlength{\parindent}{2em}
        \setCJKmainfont{Noto Sans CJK SC}
        \setCJKmonofont{Noto Sans Mono CJK SC}
        \XeTeXlinebreaklocale "zh"
        \XeTeXlinebreakskip = 0pt plus 1pt
    ''',
}

# 设置文档
latex_documents = [
    (master_doc, 'openeuler.tex', 'openEuler Embedded使用与开发手册',
     '作者：openEuler Embedded', 'manual', True),
]
```

2. docker 启动方式如下（path_to_documents需要修改为sphinx中docs对应的位置）

```
$: docker run -it --rm -v path_to_documents:/sphinx weiyuchen/sphinx-pdf:v1 make latexpdf
```

3. 编译完成后生成即会在build/latex目录下生成pdf文件

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)