首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >标题和章节在ReadTheDocs Sphinx文件中出现混乱。

标题和章节在ReadTheDocs Sphinx文件中出现混乱。
EN

Stack Overflow用户
提问于 2022-02-26 13:06:30
回答 1查看 175关注 0票数 0

出于某种原因,字幕成为ReadTheDocs为我的文档生成的PDF中的章节。

看看这里:https://yarsaw.namantech.me/_/downloads/en/latest/pdf/

以下是索引文件的代码

代码语言:javascript
复制
######################
**Welcome to YARSAW!**
######################

YARSAW is an open source, free and easy to use API Wrapper for the `Random Stuff API`_.


***************
Overview
***************

Features:

* Wraps all of the `Random Stuff API <https://api-info.pgamerx.com>`_
* Async-ready
* Easy to use
* Saves you a lot of time

*****************
Installation
*****************

To install the latest stable version of YARSAW, run the following command:

.. code-block:: bash

      python -m pip install yarsaw

To install a specific version of YARSAW, run the following command:

.. code-block:: bash

      python -m pip install yarsaw==<version>

To install the beta version of YARSAW, run the following command:

.. code-block:: bash

      python -m pip install git+https://github.com/BruceCodesGithub/yarsaw --upgrade



****************
Getting Started
****************

Get your API Keys
==================

1. Register to get an API Key at the `Random Stuff API resgistration page <https://api-docs.pgamerx.com/Getting%20Started/register/>`_. This is used for authentication.

2. Register at `RapidAPI <https://rapidapi.com/pgamerxdev/api/random-stuff-api>`_ for a RapidAPI Key and Account, and subscribe to the Random Stuff API. This is used to make requests to the Random Stuff API and keep track of them. You can go to `The RapidAPI Developer Dashboard <https://rapidapi.com/developer/apps>`_ after logging in, select an application, head over to security, and copy its key. This is your RapidAPI Key.

Examples
========

.. code-block:: python

      import yarsaw
      import asyncio # builtin, used for asynchronous calls

      client = yarsaw.Client("your_api_key", "your_rapidapi_key")

      async def joke():
         joke = await client.get_joke() # get the joke in form of a dict
         formatted_joke = yarsaw.Utils().format_joke(joke) # format the joke (optional)
         print(formatted_joke) # print the joke

      asyncio.get_event_loop().run_until_complete(joke()) # run the joke() function

Now just start reading the documentation!

****************
Contents
****************

.. tip::
   The :doc:`client` page contains all of the methods you can use to interact with the Random Stuff API, so we recommend reading that first.

.. toctree::
   :maxdepth: 1
   :caption: Documentation

   client
   utils
   
.. toctree::
   :maxdepth: 1
   :caption: Other Pages and Resources

   faq
   changelog

Documentation Last Updated on |today|

我希望欢迎来到YARSAW是第一章,下一个文件是下一个。相反,字幕变成章节,所有其他内容都变成副标题。

我遵循https://readthedocs.org/projects/documentation-style-guide-sphinx/downloads/pdf/latest/的约定语法。

它在docs页面本身(https://yarsaw.namantech.me)上工作得很好。

改变航向标志不起作用。

完整代码:https://github.com/BruceCodesGithub/yarsaw

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2022-05-02 07:47:28

解决的问题是图库树在标题下面,这会导致问题。移到文件的顶部可以解决这个问题。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/71276914

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档